domain/policy/policy-service

Classes

PolicyService

Defined in: app/src/domain/policy/policy-service.ts:66

Merges the values of all policy providers, validates them against the policy definitions and answers which value applies and whether a setting is locked.

Precedence: mandatory before recommended, and within a level machine before user. Sensitive policies are only applied from machine-wide mandatory sources. Invalid values are ignored and reported, never guessed.

Implements

• Disposable

Constructors

Constructor

new PolicyService(definitions, providers, logger, cache?): PolicyService

Defined in: app/src/domain/policy/policy-service.ts:88

Parameters

definitions

readonly PolicyDefinition<unknown>[]

All known policies, including setting policies.

providers

readonly PolicyProvider[]

Sources for the current platform.

logger

Logger

Receives read problems.

cache?

PolicyCache

Optional fallback for providers that fail at startup.

Returns

PolicyService

Properties

onDidChange

readonly onDidChange: Event<readonly string[]>

Defined in: app/src/domain/policy/policy-service.ts:80

Fires with the names of policies whose effective value changed.

Methods

applyCached()

applyCached(): boolean

Defined in: app/src/domain/policy/policy-service.ts:123

Applies the last known policies from the cache, for the time until fresh values have been read.

Returns

boolean

Whether the cache held a state; without one, nothing changes.

definitionForSetting()

definitionForSetting(settingKey): PolicyDefinition<unknown> | undefined

Defined in: app/src/domain/policy/policy-service.ts:185

The policy that belongs to a setting.

Parameters

settingKey

string

A setting key.

Returns

PolicyDefinition<unknown> | undefined

dispose()

dispose(): void

Defined in: app/src/domain/policy/policy-service.ts:209

Removes all listeners.

Returns

void

Implementation of

Disposable.dispose

getMandatory()

getMandatory(name): EffectivePolicy | undefined

Defined in: app/src/domain/policy/policy-service.ts:156

The value that a mandatory policy forces, if any.

Parameters

name

string

Policy name.

Returns

EffectivePolicy | undefined

getRecommended()

getRecommended(name): EffectivePolicy | undefined

Defined in: app/src/domain/policy/policy-service.ts:177

The recommended default from policy, if any.

Parameters

name

string

Policy name.

Returns

EffectivePolicy | undefined

isLocked()

isLocked(settingKey): boolean

Defined in: app/src/domain/policy/policy-service.ts:193

Tells whether a mandatory policy locks a setting.

Parameters

settingKey

string

A setting key.

Returns

boolean

mandatoryValue()

mandatoryValue<T>(definition): T | undefined

Defined in: app/src/domain/policy/policy-service.ts:164

The value that a mandatory policy forces, typed by its definition.

Type Parameters

T

T

Parameters

definition

PolicyDefinition<T>

The policy, as registered with this service.

Returns

T | undefined

readErrors()

readErrors(): readonly PolicyReadError[]

Defined in: app/src/domain/policy/policy-service.ts:204

Problems from the last refresh.

Returns

readonly PolicyReadError[]

refresh()

refresh(): Promise<readonly string[]>

Defined in: app/src/domain/policy/policy-service.ts:109

Reads all providers and applies the result. Calls made while a read is running share it.

Returns

Promise<readonly string[]>

The names of policies whose effective value changed.

statuses()

statuses(): readonly PolicyStatus[]

Defined in: app/src/domain/policy/policy-service.ts:199

Every value read in the last refresh, with its state.

Returns

readonly PolicyStatus[]

Interfaces

EffectivePolicy

Defined in: app/src/domain/policy/policy-service.ts:38

An applied policy value.

Properties

scope

readonly scope: PolicyScope

Defined in: app/src/domain/policy/policy-service.ts:40

source

readonly source: string

Defined in: app/src/domain/policy/policy-service.ts:41

value

readonly value: unknown

Defined in: app/src/domain/policy/policy-service.ts:39

---

PolicyCache

Defined in: app/src/domain/policy/policy-service.ts:45

Stores the last known raw values, used when a provider cannot be read at startup.

Methods

read()

read(): readonly RawPolicyValue[] | undefined

Defined in: app/src/domain/policy/policy-service.ts:47

Returns the cached values, or undefined when there is no usable cache.

Returns

readonly RawPolicyValue[] | undefined

write()

write(values): void

Defined in: app/src/domain/policy/policy-service.ts:52

Replaces the cached values.

Parameters

values

readonly RawPolicyValue[]

The values just read from the providers.

Returns

void

---

PolicyStatus

Defined in: app/src/domain/policy/policy-service.ts:26

One policy value with the reason it was or was not applied.

Properties

level

readonly level: PolicyLevel

Defined in: app/src/domain/policy/policy-service.ts:29

message?

readonly optional message?: string

Defined in: app/src/domain/policy/policy-service.ts:34

Explanation for states other than applied.

name

readonly name: string

Defined in: app/src/domain/policy/policy-service.ts:27

scope

readonly scope: PolicyScope

Defined in: app/src/domain/policy/policy-service.ts:30

source

readonly source: string

Defined in: app/src/domain/policy/policy-service.ts:31

state

readonly state: PolicyState

Defined in: app/src/domain/policy/policy-service.ts:32

value

readonly value: unknown

Defined in: app/src/domain/policy/policy-service.ts:28

Type Aliases

PolicyState

PolicyState = "applied" | "overridden" | "invalid" | "unknown" | "not-allowed-as-recommended" | "sensitive-requires-machine"

Defined in: app/src/domain/policy/policy-service.ts:17

Outcome for one policy value, as listed on the diagnostics page.

Variables

PolicyServiceToken

const PolicyServiceToken: Token<PolicyService>

Defined in: app/src/domain/policy/policy-service.ts:56

Token for the PolicyService.