Class FeatureFlagWriter

Client for managing feature flags, segments, and conditions.

Provides full write access to the Brave Ship feature flag system, including creating, updating, deleting, archiving, and moving feature flags between workspaces.

Remarks

All feature flag names must follow snake_case convention (lowercase with underscores).

Example: Basic usage

import { FeatureFlagWriter, FeatureBuilder } from '@farmart-tech/brave-admin-sdk';
import { getAuth } from 'firebase/auth';

const writer = new FeatureFlagWriter({
  api: 'https://api.farmart.com/api/v1',
  getIdToken: async () => await getAuth().currentUser.getIdToken(),
  workspace: 'production'
});

// Create a simple feature flag
await writer.setFeatureFlag('dark_mode', {
  enabled: true,
  description: 'Enable dark mode UI'
});

// Use FeatureBuilder for complex configurations
const feature = new FeatureBuilder()
  .setFeatureName('premium_features')
  .setEnabled(true)
  .setRolloutStrategy({
    type: 'percentage',
    config: { percentage: 50 }
  })
  .build();

await writer.setFeatureFlag('premium_features', feature);

Index

Constructors

constructor

new FeatureFlagWriter(options: IFeatureFlagWriterOptions): FeatureFlagWriter
Creates a new FeatureWriter client instance.
Parameters
- options: IFeatureFlagWriterOptions
  Configuration options including API URL, auth token provider, and workspace
Returns FeatureFlagWriter
Example
```
const writer = new FeatureFlagWriter({
  api: 'https://api.farmart.com/api/v1',
  getIdToken: async () => await getAuth().currentUser.getIdToken(),
  workspace: 'production'
});
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:147

Properties

`Static`FeatureBuilder

FeatureBuilder: typeof FeatureBuilder = FeatureBuilder

Static reference to FeatureBuilder for convenient access.

Example

const builder = new FeatureWriter.FeatureBuilder();

Methods

archiveFeatureFlag

archiveFeatureFlag(
flagName: string,
featureData: FeatureData | null | undefined,
): Promise<boolean>
Archives a feature flag (moves it to archived state while preserving data).
Parameters
- flagName: string
  Name of the feature flag to archive
- featureData: FeatureData | null | undefined
  Current feature flag data
Returns Promise<boolean>
Promise resolving to true if archived successfully, false if featureData is null/undefined
Remarks
Archived flags can be restored using unarchiveFeatureFlag. This is preferred over deleteFeatureFlag when you might need the configuration later.
Example
```
const featureData = await reader.getFeatureFlag('old_experiment');
await writer.archiveFeatureFlag('old_experiment', featureData);
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:465

copyFeatureToWorkspace

copyFeatureToWorkspace(
    flagName: string,
    featureData: FeatureData | null | undefined,
    workspace: string,
): Promise<false | undefined>
Copies a feature flag to another workspace without removing it from current workspace.
Parameters
- flagName: string
  Name of the feature flag to copy
- featureData: FeatureData | null | undefined
  Feature flag data to copy
- workspace: string
  Target workspace ID
Returns Promise<false | undefined>
Promise resolving to false if featureData or workspace is null/undefined
Example: Promote staging flag to production
```
const stagingFeature = await reader.getFeatureFlag('new_feature');
await writer.copyFeatureToWorkspace('new_feature', stagingFeature, 'production');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:564

deleteArchivedFeatureFlag

deleteArchivedFeatureFlag(flagName: string): Promise<void>
Permanently deletes an archived feature flag.
Parameters
- flagName: string
  Name of the archived feature flag to delete
Returns Promise<void>
Remarks
This operation is irreversible and applies only to archived flags.
Example
```
await writer.deleteArchivedFeatureFlag('very_old_experiment');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:515

deleteFeatureCondition

deleteFeatureCondition(conditionName: string): Promise<void>
Deletes a condition configuration.
Parameters
- conditionName: string
  Name of the condition to delete
Returns Promise<void>
Example
```
await writer.deleteFeatureCondition('old_condition');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:356

deleteFeatureFlag

deleteFeatureFlag(flagName: string): Promise<void>
Permanently deletes a feature flag.
Parameters
- flagName: string
  Name of the feature flag to delete
Returns Promise<void>
Remarks
This operation is irreversible. Consider using archiveFeatureFlag instead if you might need to restore the flag later.
Example
```
await writer.deleteFeatureFlag('old_experiment');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:275

deleteSegmentGroup

deleteSegmentGroup(segmentName: string): Promise<void>
Deletes a segment group.
Parameters
- segmentName: string
  Name of the segment to delete
Returns Promise<void>
Example
```
await writer.deleteSegmentGroup('old_segment');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:442

moveFeatureToWorkspace

moveFeatureToWorkspace(
    flagName: string,
    featureData: FeatureData | null | undefined,
    workspace: string,
): Promise<false | undefined>
Moves a feature flag from current workspace to another workspace.
Parameters
- flagName: string
  Name of the feature flag to move
- featureData: FeatureData | null | undefined
  Current feature flag data
- workspace: string
  Target workspace ID
Returns Promise<false | undefined>
Promise resolving to false if featureData or workspace is null/undefined
Remarks
This operation copies the flag to the target workspace and then deletes it from the current workspace. If you want to keep the flag in both workspaces, use copyFeatureToWorkspace instead.
Example
```
const feature = await reader.getFeatureFlag('new_checkout');
await writer.moveFeatureToWorkspace('new_checkout', feature, 'production');
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:539

registerFeatureCondition

registerFeatureCondition(
conditionName: string,
conditions: FeatureCondition,
): Promise<void>
Registers a new condition configuration.
Parameters
- conditionName: string
  Name for the condition (must be snake_case)
- conditions: FeatureCondition
  Condition logic definition
Returns Promise<void>
Throws
If conditionName is not in snake_case format
Example: Simple condition
```
await writer.registerFeatureCondition('premium_users', {
  field: 'userTier',
  operator: 'eq',
  value: 'premium'
});
```
Example: Complex condition with allOf
```
await writer.registerFeatureCondition('eligible_beta_users', {
  allOf: [
    { field: 'appVersion', operator: 'gte', value: '2.0.0' },
    { field: 'betaOptIn', operator: 'eq', value: true }
  ]
});
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:309

registerSegmentGroup

registerSegmentGroup(
    segmentName: string,
    segmentType:
        | "user.id"
        | "device.platform"
        | "geo.state"
        | "device.environment",
    segmentCriteria: { list: string[] },
): Promise<void>
Registers a new user segment group.
Parameters
- segmentName: string
  Name for the segment (must be snake_case)
- segmentType: "user.id" | "device.platform" | "geo.state" | "device.environment"
  Type of segment ('user' or 'device')
- segmentCriteria: { list: string[] }
  Criteria for segment membership
Returns Promise<void>
Throws
If segmentName is not in snake_case format
Example
```
await writer.registerSegmentGroup(
  'premium_users',
  'user',
  {
    field: 'tier',
    operator: 'in',
    value: ['premium', 'enterprise']
  }
);
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:383

setFeatureFlag

setFeatureFlag(
    flagName: string,
    options?: Partial<FeatureData>,
    workspace?: string,
): Promise<void>
Creates a new feature flag.
Parameters
- flagName: string
  Name of the feature flag (must be snake_case)
- options: Partial<FeatureData> = {}
  Feature flag configuration data
- workspace: string = ...
  Target workspace (defaults to instance workspace)
Returns Promise<void>
Throws
If flagName is not in snake_case format

Remarks
Flag names must be lowercase alphanumeric with underscores only.
Example: Simple flag
```
await writer.setFeatureFlag('dark_mode', {
  enabled: true,
  description: 'Enable dark mode'
});
```
Example: Flag with conditions
```
await writer.setFeatureFlag('premium_checkout', {
  enabled: true,
  condition: {
    field: 'userTier',
    operator: 'eq',
    value: 'premium'
  }
});
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:221

unarchiveFeatureFlag

unarchiveFeatureFlag(
flagName: string,
featureData: FeatureData | null | undefined,
): Promise<boolean>
Restores an archived feature flag to active state.
Parameters
- flagName: string
  Name of the archived feature flag
- featureData: FeatureData | null | undefined
  Archived feature flag data to restore
Returns Promise<boolean>
Promise resolving to true if unarchived successfully, false if featureData is null/undefined
Example
```
const archivedData = await reader.getArchivedFeatureFlag('old_experiment');
await writer.unarchiveFeatureFlag('old_experiment', archivedData);
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:490

updateFeatureCondition

updateFeatureCondition(
conditionName: string,
conditions: FeatureCondition,
): Promise<void>
Updates an existing condition configuration.
Parameters
- conditionName: string
  Name of the condition to update
- conditions: FeatureCondition
  New condition logic
Returns Promise<void>
Example
```
await writer.updateFeatureCondition('premium_users', {
  anyOf: [
    { field: 'userTier', operator: 'eq', value: 'premium' },
    { field: 'userTier', operator: 'eq', value: 'enterprise' }
  ]
});
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:336

updateFeatureFlag

updateFeatureFlag(
flagName: string,
options?: Partial<FeatureData>,
): Promise<void>
Updates an existing feature flag.
Parameters
- flagName: string
  Name of the feature flag to update
- options: Partial<FeatureData> = {}
  Partial feature flag data to update
Returns Promise<void>
Remarks
Only provided fields will be updated; other fields remain unchanged.
Example
```
// Update only the enabled status
await writer.updateFeatureFlag('dark_mode', {
  enabled: false
});
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:251

updateSegmentGroup

updateSegmentGroup(
    segmentName: string,
    segmentType:
        | "user.id"
        | "device.platform"
        | "geo.state"
        | "device.environment",
    segmentCriteria: { list: string[] },
): Promise<void>
Updates an existing segment group.
Parameters
- segmentName: string
  Name of the segment to update
- segmentType: "user.id" | "device.platform" | "geo.state" | "device.environment"
  Updated segment type
- segmentCriteria: { list: string[] }
  Updated segment criteria
Returns Promise<void>
Example
```
await writer.updateSegmentGroup(
  'premium_users',
  'user',
  {
    field: 'tier',
    operator: 'eq',
    value: 'premium_plus'
  }
);
```
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:418

`Static`preserveUpdates

preserveUpdates<T extends CommonFirebaseDataConfigs>(
current: Partial<T>,
updates: Partial<T>,
): Partial<T>
Internal
Merges updates while preserving creation timestamp from existing data.
Type Parameters
- T extends CommonFirebaseDataConfigs
Parameters
- current: Partial<T>
  Current data containing metadata
- updates: Partial<T>
  New data to merge
Returns Partial<T>
Merged data with preserved createdAt timestamp
- Defined in sdk/admin-sdk/src/feature-flag-writer.ts:179

Class FeatureFlagWriter

Remarks

Example: Basic usage

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FeatureFlagWriter

Example

Properties

StaticFeatureBuilder

Example

Methods

archiveFeatureFlag

Parameters

Returns Promise<boolean>

Remarks

Example

copyFeatureToWorkspace

Parameters

Returns Promise<false | undefined>

Example: Promote staging flag to production

deleteArchivedFeatureFlag

Parameters

Returns Promise<void>

Remarks

Example

deleteFeatureCondition

Parameters

Returns Promise<void>

Example

deleteFeatureFlag

Parameters

Returns Promise<void>

Remarks

Example

deleteSegmentGroup

Parameters

Returns Promise<void>

Example

moveFeatureToWorkspace

Parameters

Returns Promise<false | undefined>

Remarks

Example

registerFeatureCondition

Parameters

Returns Promise<void>

Throws

Example: Simple condition

Example: Complex condition with allOf

registerSegmentGroup

Parameters

Returns Promise<void>

Throws

Example

setFeatureFlag

Parameters

Returns Promise<void>

Throws

Remarks

Example: Simple flag

Example: Flag with conditions

unarchiveFeatureFlag

Parameters

Returns Promise<boolean>

Example

updateFeatureCondition

Parameters

Returns Promise<void>

Example

updateFeatureFlag

Parameters

Returns Promise<void>

Remarks

Example

updateSegmentGroup

`Static`FeatureBuilder

`Static`preserveUpdates