Functions

createDefaultConfig

Create default configuration for FlowState

Uses 1Password provider with:

• Service account token from OP_SERVICE_ACCOUNT_TOKEN env var (CI/CD)
• Falls back to CLI auth if no token (local dev)

Signature:

createDefaultConfig(overrides?: Partial<FlowstateEnvConfig> | undefined): FlowstateEnvConfig

Parameters:

Returns:

FlowstateEnvConfig -

createEnvConfig

Create configuration for env-only mode (testing/fallback)

Signature:

createEnvConfig(): FlowstateEnvConfig

Returns:

FlowstateEnvConfig -

getSecrets

Get the shared FlowstateEnv instance

Creates and initializes the instance on first call. Uses SECRETS_PROVIDER env var to determine provider:

• '1password' (default): Use 1Password
• 'env': Use environment variables

Signature:

getSecrets(): Promise<FlowstateEnv>

Returns:

Promise<FlowstateEnv> -

Examples:

const secrets = await getSecrets();
const apiKey = await secrets.get('OPENAI_API_KEY');

getSecret

Get a single secret by name

Convenience function that gets the shared instance and retrieves a secret.

Signature:

getSecret(name: string): Promise<string>

Parameters:

Returns:

Promise<string> -

Examples:

const apiKey = await getSecret('OPENAI_API_KEY');

getSecretsBatch

Get multiple secrets at once

Signature:

getSecretsBatch(names: string[]): Promise<Record<string, string>>

Parameters:

Returns:

Promise<Record<string, string>> -

Examples:

const { OPENAI_API_KEY, ANTHROPIC_API_KEY } = await getSecretsBatch([
  'OPENAI_API_KEY',
  'ANTHROPIC_API_KEY'
]);

resetSecrets

Reset the shared instance (for testing)

Signature:

resetSecrets(): void

closeSecrets

Close and cleanup the shared instance

Signature:

closeSecrets(): Promise<void>

Returns:

Promise<void> -

registerProvider

Register a custom provider

Signature:

registerProvider(name: string, provider: ProviderConstructor): void

Parameters:

getProvider

Get a provider constructor by name

Signature:

getProvider(name: string): ProviderConstructor

Parameters:

Returns:

ProviderConstructor -

listProviders

List all registered provider names

Signature:

listProviders(): string[]

Returns:

string[] -