@breadstone/archipel-mcp 0.0.31 → 0.0.32

package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagDefinition.md

@@ -0,0 +1,70 @@
+---
+title: 'Interface: IFeatureFlagDefinition'
+generated: true
+editUrl: false
+---
+# Interface: IFeatureFlagDefinition
+
+Defined in: models/IFeatureFlagDefinition.ts:6
+
+Represents a full feature flag definition for admin operations (create / update / read).
+
+## Properties
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: models/IFeatureFlagDefinition.ts:14
+
+Optional human-readable description.
+
+***
+
+### enabled
+
+```ts
+readonly enabled: boolean;
+```
+
+Defined in: models/IFeatureFlagDefinition.ts:11
+
+Whether the feature flag is currently enabled.
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: models/IFeatureFlagDefinition.ts:8
+
+Unique key identifying the feature flag.
+
+***
+
+### label?
+
+```ts
+readonly optional label?: string;
+```
+
+Defined in: models/IFeatureFlagDefinition.ts:17
+
+Optional label / environment tag (e.g. `"production"`, `"staging"`).
+
+***
+
+### variant?
+
+```ts
+readonly optional variant?: unknown;
+```
+
+Defined in: models/IFeatureFlagDefinition.ts:20
+
+Optional variant value for multivariate flags.

package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagEvaluation.md

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IFeatureFlagEvaluation'
+generated: true
+editUrl: false
+---
+# Interface: IFeatureFlagEvaluation
+
+Defined in: models/IFeatureFlagEvaluation.ts:6
+
+Result of evaluating a single feature flag.
+
+## Properties
+
+### enabled
+
+```ts
+readonly enabled: boolean;
+```
+
+Defined in: models/IFeatureFlagEvaluation.ts:11
+
+Whether the feature flag is currently enabled.
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: models/IFeatureFlagEvaluation.ts:8
+
+The unique key identifying the feature flag.
+
+***
+
+### variant?
+
+```ts
+readonly optional variant?: unknown;
+```
+
+Defined in: models/IFeatureFlagEvaluation.ts:14
+
+Optional variant value for multivariate flags / A/B testing.

package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagModuleOptions.md

@@ -0,0 +1,61 @@
+---
+title: 'Interface: IFeatureFlagModuleOptions'
+generated: true
+editUrl: false
+---
+# Interface: IFeatureFlagModuleOptions
+
+Defined in: models/IFeatureFlagModuleOptions.ts:15
+
+Configuration options for the [FeatureFlagModule](Class.FeatureFlagModule).
+
+## Properties
+
+### configEntries?
+
+```ts
+readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: models/IFeatureFlagModuleOptions.ts:32
+
+Provider-specific configuration entries to register with the config module.
+
+***
+
+### featureFlagReader
+
+```ts
+readonly featureFlagReader: Type<FeatureFlagReaderPort>;
+```
+
+Defined in: models/IFeatureFlagModuleOptions.ts:20
+
+Concrete implementation of the [FeatureFlagReaderPort](Class.FeatureFlagReaderPort).
+For example, `AzureFeatureFlagReader` or `VercelFeatureFlagReader`.
+
+***
+
+### featureFlagWriter?
+
+```ts
+readonly optional featureFlagWriter?: Type<FeatureFlagWriterPort>;
+```
+
+Defined in: models/IFeatureFlagModuleOptions.ts:27
+
+Optional concrete implementation of the [FeatureFlagWriterPort](Class.FeatureFlagWriterPort).
+For example, `AzureFeatureFlagWriter` or `VercelFeatureFlagWriter`.
+When provided the module will also export the writer port for CRUD operations.
+
+***
+
+### isGlobal?
+
+```ts
+readonly optional isGlobal?: boolean;
+```
+
+Defined in: models/IFeatureFlagModuleOptions.ts:37
+
+When `true` the module is registered globally.

package/data/packages/platform-feature-flags/api/Variable.AZURE_APPCONFIG_CONNECTION_STRING.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_APPCONFIG\_CONNECTION\_STRING'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_APPCONFIG\_CONNECTION\_STRING
+
+```ts
+const AZURE_APPCONFIG_CONNECTION_STRING: IConfigKey<string>;
+```
+
+Defined in: azure/env.ts:15
+
+Azure App Configuration connection string. Alternative to endpoint + Entra ID.

package/data/packages/platform-feature-flags/api/Variable.AZURE_APPCONFIG_ENDPOINT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_APPCONFIG\_ENDPOINT'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_APPCONFIG\_ENDPOINT
+
+```ts
+const AZURE_APPCONFIG_ENDPOINT: IConfigKey<string>;
+```
+
+Defined in: azure/env.ts:12
+
+Azure App Configuration endpoint URL. Required when using Entra ID authentication.

package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_FEATURE\_FLAG\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_FEATURE\_FLAG\_CONFIG\_ENTRIES
+
+```ts
+const AZURE_FEATURE_FLAG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: azure/env.ts:28
+
+Configuration entries required by the Azure feature flag provider.

package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_KEY_FILTER.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_FEATURE\_FLAG\_KEY\_FILTER'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_FEATURE\_FLAG\_KEY\_FILTER
+
+```ts
+const AZURE_FEATURE_FLAG_KEY_FILTER: IConfigKey<string>;
+```
+
+Defined in: azure/env.ts:21
+
+Key filter for selecting feature flags. Defaults to `*` (all).

package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_REFRESH_INTERVAL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_FEATURE\_FLAG\_REFRESH\_INTERVAL'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_FEATURE\_FLAG\_REFRESH\_INTERVAL
+
+```ts
+const AZURE_FEATURE_FLAG_REFRESH_INTERVAL: IConfigKey<number>;
+```
+
+Defined in: azure/env.ts:18
+
+Refresh interval in milliseconds for feature flag state. Defaults to 30000.

package/data/packages/platform-feature-flags/api/Variable.FEATURE_FLAG_KEY_METADATA.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: FEATURE\_FLAG\_KEY\_METADATA'
+generated: true
+editUrl: false
+---
+# Variable: FEATURE\_FLAG\_KEY\_METADATA
+
+```ts
+const FEATURE_FLAG_KEY_METADATA: "feature_flag_key" = 'feature_flag_key';
+```
+
+Defined in: decorators/FeatureFlag.ts:8
+
+Metadata key used to store the feature flag key on route handlers.

package/data/packages/platform-feature-flags/api/Variable.PLATFORM_FEATURE_FLAGS_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_FEATURE\_FLAGS\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_FEATURE\_FLAGS\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_FEATURE_FLAGS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: env.ts:37
+
+All configuration entries required by the platform-feature-flags library across all providers.

package/data/packages/platform-feature-flags/api/Variable.VERCEL_API_TOKEN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_API\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_API\_TOKEN
+
+```ts
+const VERCEL_API_TOKEN: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:25
+
+Vercel API token with write access to Edge Config. Required for write operations.

package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_EDGE\_CONFIG'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_EDGE\_CONFIG
+
+```ts
+const VERCEL_EDGE_CONFIG: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:12
+
+Vercel Edge Config connection string (includes store ID and token).

package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG_ID.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_EDGE\_CONFIG\_ID'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_EDGE\_CONFIG\_ID
+
+```ts
+const VERCEL_EDGE_CONFIG_ID: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:28
+
+Vercel Edge Config store ID. Required for write operations.

package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG_TOKEN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_EDGE\_CONFIG\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_EDGE\_CONFIG\_TOKEN
+
+```ts
+const VERCEL_EDGE_CONFIG_TOKEN: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:15
+
+Optional: Vercel Edge Config read access token (when not embedded in connection string).

package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_FEATURE\_FLAG\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_FEATURE\_FLAG\_CONFIG\_ENTRIES
+
+```ts
+const VERCEL_FEATURE_FLAG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: vercel/env.ts:38
+
+Configuration entries required by the Vercel feature flag provider (read-only).

package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_PREFIX.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_FEATURE\_FLAG\_PREFIX'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_FEATURE\_FLAG\_PREFIX
+
+```ts
+const VERCEL_FEATURE_FLAG_PREFIX: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:18
+
+Optional: Prefix for feature flag keys in Edge Config. Defaults to `featureFlags`.

package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_WRITER_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_FEATURE\_FLAG\_WRITER\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_FEATURE\_FLAG\_WRITER\_CONFIG\_ENTRIES
+
+```ts
+const VERCEL_FEATURE_FLAG_WRITER_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: vercel/env.ts:57
+
+Configuration entries required by the Vercel feature flag writer provider.

package/data/packages/platform-feature-flags/api/Variable.VERCEL_TEAM_ID.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_TEAM\_ID'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_TEAM\_ID
+
+```ts
+const VERCEL_TEAM_ID: IConfigKey<string>;
+```
+
+Defined in: vercel/env.ts:31
+
+Optional: Vercel Team ID for team-scoped API calls.

package/data/packages/platform-feature-flags/api/index.md

@@ -0,0 +1,55 @@
+---
+title: '@breadstone/archipel-platform-feature-flags'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-feature-flags
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [AzureFeatureFlagReader](Class.AzureFeatureFlagReader) | Azure App Configuration implementation of the [FeatureFlagReaderPort](Class.FeatureFlagReaderPort). Uses `@azure/app-configuration-provider` for connecting to Azure App Configuration and `@microsoft/feature-management` for evaluating feature flags. |
+| [AzureFeatureFlagWriter](Class.AzureFeatureFlagWriter) | 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. |
+| [FeatureFlagError](Class.FeatureFlagError) | Domain error thrown when a feature flag operation fails. |
+| [FeatureFlagGuard](Class.FeatureFlagGuard) | 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. |
+| [FeatureFlagModule](Class.FeatureFlagModule) | 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. |
+| [FeatureFlagReaderPort](Class.FeatureFlagReaderPort) | 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. |
+| [FeatureFlagWriterPort](Class.FeatureFlagWriterPort) | Abstract port for feature flag writer operations (CRUD). Each provider (Azure App Configuration, Vercel Edge Config) must implement this contract so that the admin UI backend can manage flags without being coupled to a specific provider. |
+| [VercelFeatureFlagReader](Class.VercelFeatureFlagReader) | Vercel Edge Config implementation of the [FeatureFlagReaderPort](Class.FeatureFlagReaderPort). Uses `@vercel/edge-config` for reading feature flag state from a Vercel Edge Config store. |
+| [VercelFeatureFlagWriter](Class.VercelFeatureFlagWriter) | Vercel Edge Config implementation of the [FeatureFlagWriterPort](Class.FeatureFlagWriterPort). Uses the Vercel REST API to manage feature flags stored in a Vercel Edge Config store. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IFeatureFlagContext](Interface.IFeatureFlagContext) | Context passed to feature flag evaluation for targeting and segmentation. |
+| [IFeatureFlagDefinition](Interface.IFeatureFlagDefinition) | Represents a full feature flag definition for admin operations (create / update / read). |
+| [IFeatureFlagEvaluation](Interface.IFeatureFlagEvaluation) | Result of evaluating a single feature flag. |
+| [IFeatureFlagModuleOptions](Interface.IFeatureFlagModuleOptions) | Configuration options for the [FeatureFlagModule](Class.FeatureFlagModule). |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [AZURE\_APPCONFIG\_CONNECTION\_STRING](Variable.AZURE_APPCONFIG_CONNECTION_STRING) | Azure App Configuration connection string. Alternative to endpoint + Entra ID. |
+| [AZURE\_APPCONFIG\_ENDPOINT](Variable.AZURE_APPCONFIG_ENDPOINT) | Azure App Configuration endpoint URL. Required when using Entra ID authentication. |
+| [AZURE\_FEATURE\_FLAG\_CONFIG\_ENTRIES](Variable.AZURE_FEATURE_FLAG_CONFIG_ENTRIES) | Configuration entries required by the Azure feature flag provider. |
+| [AZURE\_FEATURE\_FLAG\_KEY\_FILTER](Variable.AZURE_FEATURE_FLAG_KEY_FILTER) | Key filter for selecting feature flags. Defaults to `*` (all). |
+| [AZURE\_FEATURE\_FLAG\_REFRESH\_INTERVAL](Variable.AZURE_FEATURE_FLAG_REFRESH_INTERVAL) | Refresh interval in milliseconds for feature flag state. Defaults to 30000. |
+| [FEATURE\_FLAG\_KEY\_METADATA](Variable.FEATURE_FLAG_KEY_METADATA) | Metadata key used to store the feature flag key on route handlers. |
+| [PLATFORM\_FEATURE\_FLAGS\_CONFIG\_ENTRIES](Variable.PLATFORM_FEATURE_FLAGS_CONFIG_ENTRIES) | All configuration entries required by the platform-feature-flags library across all providers. |
+| [VERCEL\_API\_TOKEN](Variable.VERCEL_API_TOKEN) | Vercel API token with write access to Edge Config. Required for write operations. |
+| [VERCEL\_EDGE\_CONFIG](Variable.VERCEL_EDGE_CONFIG) | Vercel Edge Config connection string (includes store ID and token). |
+| [VERCEL\_EDGE\_CONFIG\_ID](Variable.VERCEL_EDGE_CONFIG_ID) | Vercel Edge Config store ID. Required for write operations. |
+| [VERCEL\_EDGE\_CONFIG\_TOKEN](Variable.VERCEL_EDGE_CONFIG_TOKEN) | Optional: Vercel Edge Config read access token (when not embedded in connection string). |
+| [VERCEL\_FEATURE\_FLAG\_CONFIG\_ENTRIES](Variable.VERCEL_FEATURE_FLAG_CONFIG_ENTRIES) | Configuration entries required by the Vercel feature flag provider (read-only). |
+| [VERCEL\_FEATURE\_FLAG\_PREFIX](Variable.VERCEL_FEATURE_FLAG_PREFIX) | Optional: Prefix for feature flag keys in Edge Config. Defaults to `featureFlags`. |
+| [VERCEL\_FEATURE\_FLAG\_WRITER\_CONFIG\_ENTRIES](Variable.VERCEL_FEATURE_FLAG_WRITER_CONFIG_ENTRIES) | Configuration entries required by the Vercel feature flag writer provider. |
+| [VERCEL\_TEAM\_ID](Variable.VERCEL_TEAM_ID) | Optional: Vercel Team ID for team-scoped API calls. |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [FeatureFlag](Function.FeatureFlag) | Decorator to mark endpoints that require a specific feature flag to be enabled. The guard reads this metadata to evaluate the flag before allowing access. |

package/package.json

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