SettingsStoreService
The SettingsStoreService provides a flexible settings storage system with support for scoping, permissions, and validation. It allows plugins and the core system to store and retrieve configuration data with fine-grained control over access and isolation.
Usage
Values are automatically scoped according to their field configuration:
Example
- Implements: OnModuleInit
constructor
(connection: TransactionalConnection, moduleRef: ModuleRef, configService: ConfigService) => SettingsStoreServiceonModuleInit
() => register
(registration: SettingsStoreRegistration) => voidRegister settings store fields. This is typically called during application bootstrap when processing the VendureConfig.
get
(ctx: RequestContext, key: string) => Promise<T | undefined>Get a value for the specified key. The value is automatically scoped according to the field's scope configuration.
get
(key: string, ctx: RequestContext) => Promise<T | undefined>get
(keyOrCtx: string | RequestContext, ctxOrKey: RequestContext | string) => Promise<T | undefined>getMany
(ctx: RequestContext, keys: string[]) => Promise<Record<string, JsonCompatible<any>>>Get multiple values efficiently. Each key is scoped according to its individual field configuration.
getMany
(keys: string[], ctx: RequestContext) => Promise<Record<string, JsonCompatible<any>>>getMany
(keysOrCtx: string[] | RequestContext, ctxOrKeys: RequestContext | string[]) => Promise<Record<string, JsonCompatible<any>>>set
(ctx: RequestContext, key: string, value: T) => Promise<SetSettingsStoreValueResult>Set a value for the specified key with structured result feedback. This version returns detailed information about the success or failure of the operation instead of throwing errors.
set
(key: string, value: T, ctx: RequestContext) => Promise<SetSettingsStoreValueResult>set
(keyOrCtx: string | RequestContext, keyOrValue: string | T, ctxOrValue: RequestContext | T) => Promise<SetSettingsStoreValueResult>setMany
(ctx: RequestContext, values: Record<string, JsonCompatible<any>>) => Promise<SetSettingsStoreValueResult[]>Set multiple values with structured result feedback for each operation. This method will not throw errors but will return detailed results for each key-value pair.
setMany
(values: Record<string, JsonCompatible<any>>, ctx: RequestContext) => Promise<SetSettingsStoreValueResult[]>setMany
(valuesOrCtx: Record<string, JsonCompatible<any>> | RequestContext, ctxOrValues: RequestContext | Record<string, JsonCompatible<any>>) => Promise<SetSettingsStoreValueResult[]>getFieldDefinition
(key: string) => SettingsStoreFieldConfig | undefinedGet the field configuration for a key.
getAllFieldDefinitions
Returns all registered field definitions with their full keys.
getScopeType
Determines the scope type of a field by comparing its scope function reference to the pre-built SettingsStoreScopes functions.
validateValue
(key: string, value: any, ctx: RequestContext) => Promise<string | void>Validate a value against its field definition.
findOrphanedEntries
(options: CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise<OrphanedSettingsStoreEntry[]>Find orphaned settings store entries that no longer have corresponding field definitions.
cleanupOrphanedEntries
(options: CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise<CleanupOrphanedSettingsStoreEntriesResult>Clean up orphaned settings store entries from the database.
hasPermission
(ctx: RequestContext, key: string) => booleanCheck if the current user has permission to access a field. This is not called internally in the get and set methods, so should be used by any methods which are exposing these methods via the GraphQL APIs.
hasReadPermission
Check if the current user has permission to read a field.
hasWritePermission
Check if the current user has permission to write a field.
isReadonly
(key: string) => booleanReturns true if the settings field has the readonly: true configuration.