@breadstone/archipel-mcp 0.0.30 → 0.0.32

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

@@ -0,0 +1,180 @@
+---
+title: 'Abstract Class: FeatureFlagWriterPort'
+generated: true
+editUrl: false
+---
+# Abstract Class: FeatureFlagWriterPort
+
+Defined in: contracts/FeatureFlagWriterPort.ts:19
+
+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.
+
+## Remarks
+
+This port is intentionally separated from [FeatureFlagReaderPort](Class.FeatureFlagReaderPort) because
+the read path (consumed by application code) and the write path (consumed by admin tooling)
+have different deployment contexts, security requirements, and SDK dependencies.
+
+## Extended by
+
+- [`AzureFeatureFlagWriter`](Class.AzureFeatureFlagWriter)
+- [`VercelFeatureFlagWriter`](Class.VercelFeatureFlagWriter)
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeatureFlagWriterPort(): FeatureFlagWriterPort;
+```
+
+#### Returns
+
+`FeatureFlagWriterPort`
+
+## Methods
+
+### createFlag()
+
+```ts
+abstract createFlag(definition): Promise<void>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:46
+
+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.
+
+***
+
+### deleteFlag()
+
+```ts
+abstract deleteFlag(key): Promise<void>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:66
+
+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.
+
+***
+
+### getFlag()
+
+```ts
+abstract getFlag(key): Promise<
+  | IFeatureFlagDefinition
+| undefined>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:29
+
+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.
+
+***
+
+### listFlags()
+
+```ts
+abstract listFlags(): Promise<readonly IFeatureFlagDefinition[]>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:37
+
+Returns all feature flag definitions managed by the provider.
+
+#### Returns
+
+`Promise`\<readonly [`IFeatureFlagDefinition`](Interface.IFeatureFlagDefinition)[]\>
+
+Array of flag definitions.
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:75
+
+Lightweight connectivity check for the writer provider.
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+***
+
+### updateFlag()
+
+```ts
+abstract updateFlag(key, updates): Promise<void>;
+```
+
+Defined in: contracts/FeatureFlagWriterPort.ts:57
+
+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.

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

@@ -0,0 +1,223 @@
+---
+title: 'Class: VercelFeatureFlagReader'
+generated: true
+editUrl: false
+---
+# Class: VercelFeatureFlagReader
+
+Defined in: vercel/VercelFeatureFlagReader.ts:41
+
+Vercel Edge Config implementation of the [FeatureFlagReaderPort](Class.FeatureFlagReaderPort).
+Uses `@vercel/edge-config` for reading feature flag state from a Vercel Edge Config store.
+
+Feature flags are expected to be stored as a single object in Edge Config
+under the configured prefix key (default: `featureFlags`). The object maps
+flag keys to their values (boolean for simple on/off, or any value for variants).
+
+## Example
+
+Edge Config structure:
+```json
+{
+  "featureFlags": {
+    "new-checkout-flow": true,
+    "pricing-tier": "enterprise",
+    "max-upload-size": 100
+  }
+}
+```
+
+## Extends
+
+- [`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort)
+
+## Implements
+
+- `OnModuleInit`
+
+## Constructors
+
+### Constructor
+
+```ts
+new VercelFeatureFlagReader(configService): VercelFeatureFlagReader;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:53
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`VercelFeatureFlagReader`
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`constructor`](Class.FeatureFlagReaderPort#constructor)
+
+## Methods
+
+### getAllFlags()
+
+```ts
+getAllFlags(_context?): Promise<readonly IFeatureFlagEvaluation[]>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:130
+
+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.
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`getAllFlags`](Class.FeatureFlagReaderPort#getallflags)
+
+***
+
+### getVariant()
+
+```ts
+getVariant<T>(
+   key, 
+   defaultValue, 
+_context?): Promise<T>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:109
+
+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.
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`getVariant`](Class.FeatureFlagReaderPort#getvariant)
+
+***
+
+### isEnabled()
+
+```ts
+isEnabled(key, _context?): Promise<boolean>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:88
+
+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.
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`isEnabled`](Class.FeatureFlagReaderPort#isenabled)
+
+***
+
+### onModuleInit()
+
+```ts
+onModuleInit(): Promise<void>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:67
+
+Initializes the Vercel Edge Config client.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit
+```
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:160
+
+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.
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`ping`](Class.FeatureFlagReaderPort#ping)
+
+***
+
+### refresh()
+
+```ts
+refresh(): Promise<void>;
+```
+
+Defined in: vercel/VercelFeatureFlagReader.ts:154
+
+Refreshes the flag state from the remote provider.
+Implementations should reload configuration from the upstream source.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort).[`refresh`](Class.FeatureFlagReaderPort#refresh)

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

@@ -0,0 +1,240 @@
+---
+title: 'Class: VercelFeatureFlagWriter'
+generated: true
+editUrl: false
+---
+# Class: VercelFeatureFlagWriter
+
+Defined in: vercel/VercelFeatureFlagWriter.ts:33
+
+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.
+
+## Remarks
+
+The Vercel admin client stores feature flags as a single object under the configured
+prefix key (default: `featureFlags`). Each flag key maps to a [IFeatureFlagDefinition](Interface.IFeatureFlagDefinition)
+serialized as JSON.
+
+## Extends
+
+- [`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort)
+
+## Implements
+
+- `OnModuleInit`
+
+## Constructors
+
+### Constructor
+
+```ts
+new VercelFeatureFlagWriter(configService): VercelFeatureFlagWriter;
+```
+
+Defined in: vercel/VercelFeatureFlagWriter.ts:47
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`VercelFeatureFlagWriter`
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`constructor`](Class.FeatureFlagWriterPort#constructor)
+
+## Methods
+
+### createFlag()
+
+```ts
+createFlag(definition): Promise<void>;
+```
+
+Defined in: vercel/VercelFeatureFlagWriter.ts:135
+
+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: vercel/VercelFeatureFlagWriter.ts:200
+
+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: vercel/VercelFeatureFlagWriter.ts:86
+
+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: vercel/VercelFeatureFlagWriter.ts:111
+
+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: vercel/VercelFeatureFlagWriter.ts:61
+
+Initializes the Vercel admin client by reading configuration.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit
+```
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: vercel/VercelFeatureFlagWriter.ts:228
+
+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: vercel/VercelFeatureFlagWriter.ts:163
+
+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/Function.FeatureFlag.md

@@ -0,0 +1,25 @@
+---
+title: 'Function: FeatureFlag()'
+generated: true
+editUrl: false
+---
+# Function: FeatureFlag()
+
+```ts
+function FeatureFlag(flagKey): CustomDecorator<unknown>;
+```
+
+Defined in: decorators/FeatureFlag.ts:17
+
+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.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `flagKey` | `string` | The unique key of the feature flag to check. |
+
+## Returns
+
+`CustomDecorator`\<`unknown`\>

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

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IFeatureFlagContext'
+generated: true
+editUrl: false
+---
+# Interface: IFeatureFlagContext
+
+Defined in: models/IFeatureFlagContext.ts:6
+
+Context passed to feature flag evaluation for targeting and segmentation.
+
+## Properties
+
+### attributes?
+
+```ts
+readonly optional attributes?: Readonly<Record<string, unknown>>;
+```
+
+Defined in: models/IFeatureFlagContext.ts:14
+
+Arbitrary attributes for custom targeting rules.
+
+***
+
+### groups?
+
+```ts
+readonly optional groups?: readonly string[];
+```
+
+Defined in: models/IFeatureFlagContext.ts:11
+
+Groups or segments the user belongs to (e.g. beta testers, enterprise).
+
+***
+
+### userId?
+
+```ts
+readonly optional userId?: string;
+```
+
+Defined in: models/IFeatureFlagContext.ts:8
+
+Unique identifier of the current user.