Classes

Cache

In-memory cache with TTL support

Constructor

constructor(config?: Partial<CacheConfig>)

Parameters:

Parameter	Type	Required	Description
`config`	`Partial<CacheConfig>`	No

Methods

set

Store a value in cache with TTL

set(key: string, value: string): void

Parameters:

Parameter	Type	Required	Description
`key`	`string`	Yes
`value`	`string`	Yes

get

Retrieve a value from cache if not expired

get(key: string): string | undefined

Parameters:

Parameter	Type	Required	Description
`key`	`string`	Yes

Returns:

string \| undefined -

delete

Delete a specific key

delete(key: string): void

Parameters:

Parameter	Type	Required	Description
`key`	`string`	Yes

clear

Clear all cached values

clear(): void

keys

Get all cached keys (including expired)

keys(): string[]

Returns:

string[] -

FlowstateEnv

Main client for FlowstateEnv secrets management

Constructor

constructor(config: FlowstateEnvConfig)

Parameters:

Parameter	Type	Required	Description
`config`	`FlowstateEnvConfig`	Yes

Methods

initialize

Initialize the provider

initialize(): Promise<void>

Returns:

Promise<void> -

get

Get a secret by reference Uses cache if enabled

get(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

refresh

Refresh a secret (bypass cache)

refresh(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

refreshAll

Refresh all cached secrets

refreshAll(): Promise<void>

Returns:

Promise<void> -

list

List available secrets

list(filter?: string | undefined): Promise<string[]>

Parameters:

Parameter	Type	Required	Description
`filter`	`string \| undefined`	No

Returns:

Promise<string[]> -

clearCache

Clear the cache

clearCache(): void

close

Close the provider and clean up

close(): Promise<void>

Returns:

Promise<void> -

BaseProvider

Abstract base class for secret providers Implements common functionality like initialization checks

Constructor

constructor(name: string)

Parameters:

Parameter	Type	Required	Description
`name`	`string`	Yes

Properties

Property	Type	Required	Description
`initialized`	`boolean`	Yes

Methods

initialize

Initialize the provider - must be called before use

initialize(config: ProviderConfig): Promise<void>

Parameters:

Parameter	Type	Required	Description
`config`	`ProviderConfig`	Yes

Returns:

Promise<void> -

getSecret

Get a secret by reference

getSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

listSecrets

List available secrets

listSecrets(filter?: string | undefined): Promise<string[]>

Parameters:

Parameter	Type	Required	Description
`filter`	`string \| undefined`	No

Returns:

Promise<string[]> -

refreshSecret

Refresh a specific secret

refreshSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

close

Close the provider and clean up resources

close(): Promise<void>

Returns:

Promise<void> -

ensureInitialized

Check if provider is initialized

ensureInitialized(): void

OnePasswordClient

Wrapper for 1Password SDK client

Constructor

constructor(config: OnePasswordConfig)

Parameters:

Parameter	Type	Required	Description
`config`	`OnePasswordConfig`	Yes

Methods

initialize

Initialize the 1Password SDK client

initialize(): Promise<void>

Returns:

Promise<void> -

resolveSecret

Resolve a secret reference

resolveSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes	- Full op:// reference or simple key name

Returns:

Promise<string> -

close

Close the client connection

close(): Promise<void>

Returns:

Promise<void> -

OnePasswordProvider

Provider for 1Password secrets using

Constructor

constructor()

Methods

initialize

initialize(config: ProviderConfig): Promise<void>

Parameters:

Parameter	Type	Required	Description
`config`	`ProviderConfig`	Yes

Returns:

Promise<void> -

getSecret

getSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

listSecrets

listSecrets(filter?: string | undefined): Promise<string[]>

Parameters:

Parameter	Type	Required	Description
`filter`	`string \| undefined`	No

Returns:

Promise<string[]> -

refreshSecret

refreshSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

close

close(): Promise<void>

Returns:

Promise<void> -

EnvProvider

Simple provider that reads secrets from process.env Useful as fallback or for local development

Constructor

constructor()

Methods

initialize

initialize(config: ProviderConfig): Promise<void>

Parameters:

Parameter	Type	Required	Description
`config`	`ProviderConfig`	Yes

Returns:

Promise<void> -

getSecret

getSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -

listSecrets

listSecrets(filter?: string | undefined): Promise<string[]>

Parameters:

Parameter	Type	Required	Description
`filter`	`string \| undefined`	No

Returns:

Promise<string[]> -

refreshSecret

refreshSecret(reference: string): Promise<string>

Parameters:

Parameter	Type	Required	Description
`reference`	`string`	Yes

Returns:

Promise<string> -