Class DefaultSecretService

Internal service providing secret storage via OS-native credential stores. Not registered in Context -- used internally by DefaultKeyValueService (see dynamic-cli-framework).

Implements

SecretService

Index

Constructors

Methods

clearScope deleteSecret getSecret hasSecret setScope setSecret

Constructors

constructor

new DefaultSecretService(
serviceName: string,
secretsApi?: SecretsApi,
): DefaultSecretService
Parameters
- serviceName: string
- OptionalsecretsApi: SecretsApi
Returns DefaultSecretService
- Defined in src/service/configuration/DefaultSecretService.ts:18

Methods

clearScope

clearScope(): void
Returns void
- Defined in src/service/configuration/DefaultSecretService.ts:36

deleteSecret

deleteSecret(bunSecretName: string): Promise<boolean>
Delete a secret by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<boolean>
Implementation of SecretService.deleteSecret
- Defined in src/service/configuration/DefaultSecretService.ts:66

getSecret

getSecret(bunSecretName: string): Promise<string | null>
Retrieve a secret value by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<string | null>
Implementation of SecretService.getSecret
- Defined in src/service/configuration/DefaultSecretService.ts:59

hasSecret

hasSecret(bunSecretName: string): Promise<boolean>
Check if a secret exists by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<boolean>
Implementation of SecretService.hasSecret
- Defined in src/service/configuration/DefaultSecretService.ts:73

setScope

setScope(scope: string): void
Parameters
- scope: string
Returns void
- Defined in src/service/configuration/DefaultSecretService.ts:32

setSecret

setSecret(key: string, value: string): Promise<string>
Store a secret value. Constructs the Bun secret name from the current scope and key.
Parameters
- key: string
- value: string
Returns Promise<string>
the constructed Bun secret name (used as part of the sentinel value in the key-value Map).
Implementation of SecretService.setSecret
- Defined in src/service/configuration/DefaultSecretService.ts:40