UI kit reference

zidane-ui/settings/testing/contract

import { … } from 'zidane-ui/settings/testing/contract'ui/src/settings/testing/contract.ts

Functions#

`describeSettingsAccountsContract`Function#

Declares the shared suite of the providers and mcp groups for one implementation.

TypeScript

function describeSettingsAccountsContract(
  name: string,
  makeHarness: SettingsAccountsHarnessFactory,
  capabilities: readonly SettingsAccountsCapability[],
): void

Parameters

Parameters
Name	Type	Description
name	`string`	The implementation's name, shown in the suite title.
makeHarness	`SettingsAccountsHarnessFactory`	Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`readonly SettingsAccountsCapability[]`	The groups and actions the host offers. Every other one must be undefined.

ui/src/settings/testing/accounts.contract.ts:162

`describeSettingsClaudeImportContract`Function#

Declares the shared SettingsHost.claudeImport suite for one implementation.

TypeScript

function describeSettingsClaudeImportContract(
  name: string,
  makeHarness: SettingsClaudeImportHarnessFactory,
  offered: boolean,
): void

Parameters

Parameters
Name	Type	Description
name	`string`	The implementation's name, shown in the suite title.
makeHarness	`SettingsClaudeImportHarnessFactory`	Builds a fresh host over a backend that holds what it is given, once per test.
offered	`boolean`	Whether the host offers `claudeImport`.

ui/src/settings/testing/claude-import.contract.ts:57

`describeSettingsExtensionOptionsContract`Function#

Declares the shared extension options suite for one implementation.

TypeScript

function describeSettingsExtensionOptionsContract(
  name: string,
  makeHarness: SettingsExtensionOptionsHarnessFactory,
  capabilities: readonly SettingsExtensionOptionsCapability[],
): void

Parameters

Parameters
Name	Type	Description
name	`string`	The implementation's name, shown in the suite title.
makeHarness	`SettingsExtensionOptionsHarnessFactory`	Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`readonly SettingsExtensionOptionsCapability[]`	The members the host offers. Every other one must be undefined.

ui/src/settings/testing/extension-options.contract.ts:104

`describeSettingsHostContract`Function#

Declares the shared SettingsHost suite for one implementation.

TypeScript

function describeSettingsHostContract(
  name: string,
  makeHarness: SettingsHostHarnessFactory,
  capabilities: readonly SettingsHostCapability[],
  traits?: SettingsHostContractTraits,
): void

Parameters

Parameters
Name	Type	Default	Description
name	`string`		The implementation's name, shown in the suite title.
makeHarness	`SettingsHostHarnessFactory`		Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`readonly SettingsHostCapability[]`		The optional members the host offers. Every other optional member must be undefined.
traits?	`SettingsHostContractTraits`	`{}`	The failures the backend can stage.

ui/src/settings/testing/contract.ts:95

`describeSettingsModelsContract`Function#

Declares the shared SettingsHost.models suite for one implementation.

TypeScript

function describeSettingsModelsContract(
  name: string,
  makeHarness: SettingsModelsHarnessFactory,
  capabilities: readonly SettingsModelsCapability[],
): void

Parameters

Parameters
Name	Type	Description
name	`string`	The implementation's name, shown in the suite title.
makeHarness	`SettingsModelsHarnessFactory`	Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`readonly SettingsModelsCapability[]`	The members of `models` the host offers. Every other one must be undefined.

ui/src/settings/testing/models.contract.ts:72

`describeSettingsPerformanceContract`Function#

Declares the shared SettingsHost.performance suite for one implementation.

TypeScript

function describeSettingsPerformanceContract(
  name: string,
  makeHarness: SettingsPerformanceHarnessFactory,
  capabilities: false | readonly SettingsPerformanceCapability[],
  options?: SettingsPerformanceContractOptions,
): void

Parameters

Parameters
Name	Type	Default	Description
name	`string`		The implementation's name, shown in the suite title.
makeHarness	`SettingsPerformanceHarnessFactory`		Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`false \| readonly SettingsPerformanceCapability[]`		The optional members the host offers; `false`: no `performance` at all.
options?	`SettingsPerformanceContractOptions`	`{}`	What else to check (refused watches).

ui/src/settings/testing/performance.contract.ts:103

`describeSettingsSectionsContract`Function#

Declares the shared suite of the catalog and diagnostics groups for one implementation.

TypeScript

function describeSettingsSectionsContract(
  name: string,
  makeHarness: SettingsSectionsHarnessFactory,
  capabilities: readonly SettingsSectionsCapability[],
): void

Parameters

Parameters
Name	Type	Description
name	`string`	The implementation's name, shown in the suite title.
makeHarness	`SettingsSectionsHarnessFactory`	Builds a fresh host over a backend that holds what it is given, once per test.
capabilities	`readonly SettingsSectionsCapability[]`	The groups the host offers. Every other group must be undefined.

ui/src/settings/testing/sections.contract.ts:195

Constants#

`ACCOUNTS_CONTRACT_CWD`Constant#

The folder the suite's MCP calls name.

TypeScript

const ACCOUNTS_CONTRACT_CWD = '/work/app'

ui/src/settings/testing/accounts.contract.ts:84

Interfaces#

`SettingsAccountsBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsAccountsBackend

Properties

SettingsAccountsBackend properties
Name	Type	Description
instances	`SettingsMcpInstance[]`	The running processes of those servers.
providers	`SettingsProvider[]`	The providers and their credentials.
servers	`SettingsMcpServer[]`	The MCP servers of the folder the suite names (`ACCOUNTS_CONTRACT_CWD`).

ui/src/settings/testing/accounts.contract.ts:47

`SettingsAccountsControl`Interface#

Reads the backend and acts on it from outside.

TypeScript

interface SettingsAccountsControl

Properties

SettingsAccountsControl properties
Name	Type	Description
credentials	`(provider: string) => readonly SettingsCredential[]`	The stored credentials of a provider now (no `env`).
finishSignIn	`() => void \| Promise<void>`	The browser of the sign-in that waits came back: it finishes.
restarts?	`() => readonly string[]`	The servers restarted, in order. Required with `mcp.restart`.
serverNames	`() => string[]`	The servers held now, by name.

ui/src/settings/testing/accounts.contract.ts:57

`SettingsAccountsHarness`Interface#

A host built over a backend, its control, and how to tear them down.

TypeScript

interface SettingsAccountsHarness

Properties

SettingsAccountsHarness properties
Name	Type	Description
control	`SettingsAccountsControl`	Reads and acts on the backend.
host	`SettingsHost`	The host under test.
dispose?	`() => void`	Closes listeners after each test.

ui/src/settings/testing/accounts.contract.ts:69

`SettingsClaudeImportBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsClaudeImportBackend

Properties

SettingsClaudeImportBackend properties
Name	Type	Description
detect	`SettingsClaudeImportDetect`	What `~/.claude` holds.
summary	`SettingsClaudeImportSummary`	What an import answers.

ui/src/settings/testing/claude-import.contract.ts:19

`SettingsClaudeImportHarness`Interface#

A host built over a backend, and how to tear it down.

TypeScript

interface SettingsClaudeImportHarness

Properties

SettingsClaudeImportHarness properties
Name	Type	Description
host	`SettingsHost`	The host under test.
dispose?	`() => void`	Closes listeners after each test.
runs?	`() => SettingsClaudeImportSelection[]`	The selections the backend imported, in order.

ui/src/settings/testing/claude-import.contract.ts:27

`SettingsExtensionOptionsBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsExtensionOptionsBackend

Properties

SettingsExtensionOptionsBackend properties
Name	Type	Description
actions	`SettingsExtensionAction[]`	The action rows declared.
runs	`Record<string, SettingsExtensionActionResult>`	What running each action answers, keyed `extension:key`.
schema	`WireExtensionConfigSchema`	The options declared (for every folder).
statuses	`Record<string, SettingsExtensionActionStatus>`	The probes, keyed `extension:key`.

ui/src/settings/testing/extension-options.contract.ts:36

`SettingsExtensionOptionsHarness`Interface#

A host built over a backend, and how to tear it down.

TypeScript

interface SettingsExtensionOptionsHarness

Properties

SettingsExtensionOptionsHarness properties
Name	Type	Description
host	`SettingsHost`	The host under test.
created?	`() => string[]`	The extensions scaffolded, by name.
dispose?	`() => void`	Closes listeners after each test.

ui/src/settings/testing/extension-options.contract.ts:48

`SettingsHostContractBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsHostContractBackend

Properties

SettingsHostContractBackend properties
Name	Type	Description
unreadable	`boolean`	Reads fail.
values	`Partial<Settings>`	The stored settings (a partial document: the host fills the rest from `DEFAULT_SETTINGS`).
writable	`boolean`	This connection may write.

ui/src/settings/testing/contract.ts:38

`SettingsHostContractControl`Interface#

Reads the backend and changes it from outside.

TypeScript

interface SettingsHostContractControl

Properties

SettingsHostContractControl properties
Name	Type	Description
refuse?	`(next: boolean) => void`	Refuse the next writes (`traits.refusedWrite`).
store	`(patch: Partial<Settings>) => void`	Another writer changed the stored settings. The host shows them after its next `refresh` (or sooner).
stored	`() => Partial<Settings>`	The settings stored now.

ui/src/settings/testing/contract.ts:48

`SettingsHostContractTraits`Interface#

Failures the backend can stage. Default: both.

TypeScript

interface SettingsHostContractTraits

Properties

SettingsHostContractTraits properties
Name	Type	Description
failedRead?	`boolean`	A read can fail (the document lands on an error).
refusedWrite?	`boolean`	A write can be refused (`control.refuse`).

ui/src/settings/testing/contract.ts:73

`SettingsHostHarness`Interface#

A host built over a backend, the backend's control, and how to tear them down.

TypeScript

interface SettingsHostHarness

Properties

SettingsHostHarness properties
Name	Type	Description
control	`SettingsHostContractControl`	Reads and changes the backend.
host	`SettingsHost`	The host under test.
dispose?	`() => void`	Closes listeners after each test.

ui/src/settings/testing/contract.ts:58

`SettingsModelsBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsModelsBackend

Properties

SettingsModelsBackend properties
Name	Type	Description
decisionModels	`SettingsDecisionModel[]`	The decision models (for every folder).
lastUsed	`ModelPickRef \| null`	The last model picked.
tests	`Record<string, SettingsModelTest>`	How a test of each model goes, by model setting (`"provider/model"`); a model left out fails.

ui/src/settings/testing/models.contract.ts:25

`SettingsModelsHarness`Interface#

A host built over a backend, and how to tear it down.

TypeScript

interface SettingsModelsHarness

Properties

SettingsModelsHarness properties
Name	Type	Description
host	`SettingsHost`	The host under test.
dispose?	`() => void`	Closes listeners after each test.

ui/src/settings/testing/models.contract.ts:35

`SettingsPerformanceBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsPerformanceBackend

Properties

SettingsPerformanceBackend properties
Name	Type	Description
profile	`PerfProfileOutcome`	What a profile answers.
reportPath	`string`	Where a report is written.
samples	`PerfSample[]`	The samples held, oldest first.
threads	`Record<number, PerfOsThread[]>`	Each process's threads.
watchError?	`PerfWatchError`	Set: the backend refuses every watch with this (only with `watchErrors`).

ui/src/settings/testing/performance.contract.ts:34

`SettingsPerformanceContractOptions`Interface#

What the suite checks beyond the members.

TypeScript

interface SettingsPerformanceContractOptions

Properties

SettingsPerformanceContractOptions properties
Name	Type	Description
watchErrors?	`boolean`	The host can refuse a watch: build it over `backend.watchError`.

ui/src/settings/testing/performance.contract.ts:48

`SettingsPerformanceControl`Interface#

Drives the backend and reads it back.

TypeScript

interface SettingsPerformanceControl

Properties

SettingsPerformanceControl properties
Name	Type	Description
emit	`(sample: PerfSample) => void`	The backend takes a sample: every watcher gets it.
profiles	`() => { seconds: number; target: PerfProfileTarget }[]`	Profiles the backend recorded, in order.
resets	`() => number`	Counter resets the backend took.
watching	`() => number`	How many watches are open on the backend (it samples only while one is).

ui/src/settings/testing/performance.contract.ts:54

`SettingsPerformanceHarness`Interface#

A host built over a backend, its control, and how to tear them down.

TypeScript

interface SettingsPerformanceHarness

Properties

SettingsPerformanceHarness properties
Name	Type	Description
control	`SettingsPerformanceControl`	Drives the backend: pushes samples, fails calls.
host	`SettingsHost`	The host under test, its `performance` member over the backend.
dispose?	`() => void`	Tears the host down after the test.

ui/src/settings/testing/performance.contract.ts:66

`SettingsSectionsBackend`Interface#

What the backend behind the host holds.

TypeScript

interface SettingsSectionsBackend

Properties

SettingsSectionsBackend properties
Name	Type	Description
environments	`EnvironmentDescriptor[]`	The environment kinds.
extensions	`SettingsExtension[]`	The extensions on disk (for every folder).
hostCatalog	`FixtureHostCatalogs \| null`	`null`: the host can't list its catalogs (an older server).
instructions	`Record<string, ContextSegmentsReport>`	Each session's prompt.
logs	`LogRecord[]`	The log records held.
plugins	`SettingsPlugin[]`	The plugins (for every folder).
skills	`SkillConfig[]`	The skills on disk (for every folder).

ui/src/settings/testing/sections.contract.ts:46

`SettingsSectionsControl`Interface#

Reads the backend and changes it from outside.

TypeScript

interface SettingsSectionsControl

Properties

SettingsSectionsControl properties
Name	Type	Description
catalogChanged	`(kind: SettingsCatalogKind) => void`	One of the host's catalogs changed there (another client installed something).
environmentChanges	`() => readonly EnvironmentSettingsChange[]`	Environment edits the backend took, in order.
extensionNames	`() => string[]`	The extensions held now (by name).
log	`(record: LogRecord) => void`	The backend logs a record.
skillNames	`() => string[]`	The skills held now (by name).

ui/src/settings/testing/sections.contract.ts:64

`SettingsSectionsHarness`Interface#

A host built over a backend, its control, and how to tear them down.

TypeScript

interface SettingsSectionsHarness

Properties

SettingsSectionsHarness properties
Name	Type	Description
control	`SettingsSectionsControl`	Reads and changes the backend.
host	`SettingsHost`	The host under test.
dispose?	`() => void`	Closes listeners after each test.

ui/src/settings/testing/sections.contract.ts:78

Types#

`SettingsAccountsCapability`Type#

A group of SettingsHost this suite covers, or one of its optional actions.

TypeScript

type SettingsAccountsCapability =
  | 'providers'
  | 'providers.setApiKey'
  | 'providers.configure'
  | 'providers.clear'
  | 'providers.remove'
  | 'providers.setPreferred'
  | 'providers.rename'
  | 'providers.signIn'
  | 'mcp'
  | 'mcp.test'
  | 'mcp.signIn'
  | 'mcp.signOut'
  | 'mcp.add'
  | 'mcp.remove'
  | 'mcp.instances'
  | 'mcp.restart'

ui/src/settings/testing/accounts.contract.ts:25

`SettingsAccountsHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsAccountsHarnessFactory = (backend: SettingsAccountsBackend) => SettingsAccountsHarness | Promise<SettingsAccountsHarness>

ui/src/settings/testing/accounts.contract.ts:79

`SettingsClaudeImportHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsClaudeImportHarnessFactory = (backend: SettingsClaudeImportBackend) => SettingsClaudeImportHarness | Promise<SettingsClaudeImportHarness>

ui/src/settings/testing/claude-import.contract.ts:37

`SettingsExtensionOptionsCapability`Type#

An extension options member of SettingsHost.extensions.

TypeScript

type SettingsExtensionOptionsCapability =
  | 'configSchema'
  | 'actions'
  | 'actionStatuses'
  | 'runAction'
  | 'create'

ui/src/settings/testing/extension-options.contract.ts:25

`SettingsExtensionOptionsHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsExtensionOptionsHarnessFactory = (backend: SettingsExtensionOptionsBackend) => SettingsExtensionOptionsHarness | Promise<SettingsExtensionOptionsHarness>

ui/src/settings/testing/extension-options.contract.ts:58

`SettingsHostCapability`Type#

An optional SettingsHost member.

TypeScript

type SettingsHostCapability = 'update' | 'writable'

ui/src/settings/testing/contract.ts:33

`SettingsHostHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsHostHarnessFactory = (backend: SettingsHostContractBackend) => SettingsHostHarness | Promise<SettingsHostHarness>

ui/src/settings/testing/contract.ts:68

`SettingsModelsCapability`Type#

A member of SettingsHost.models.

TypeScript

type SettingsModelsCapability = 'decisionModels' | 'test' | 'testDecision' | 'lastUsed'

ui/src/settings/testing/models.contract.ts:20

`SettingsModelsHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsModelsHarnessFactory = (backend: SettingsModelsBackend) => SettingsModelsHarness | Promise<SettingsModelsHarness>

ui/src/settings/testing/models.contract.ts:43

`SettingsPerformanceCapability`Type#

An optional member of SettingsHost.performance.

TypeScript

type SettingsPerformanceCapability =
  | 'threads'
  | 'resetCounters'
  | 'exportReport'
  | 'profile'

ui/src/settings/testing/performance.contract.ts:29

`SettingsPerformanceHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsPerformanceHarnessFactory = (backend: SettingsPerformanceBackend) => SettingsPerformanceHarness | Promise<SettingsPerformanceHarness>

ui/src/settings/testing/performance.contract.ts:76

`SettingsSectionsCapability`Type#

A catalog or diagnostics group of SettingsHost.

TypeScript

type SettingsSectionsCapability =
  | 'skills'
  | 'extensions'
  | 'plugins'
  | 'instructions'
  | 'environments'
  | 'logs'
  | 'hostCatalog'
  | 'paths'

ui/src/settings/testing/sections.contract.ts:31

`SettingsSectionsHarnessFactory`Type#

Builds a fresh host (and its backend) for one test.

TypeScript

type SettingsSectionsHarnessFactory = (backend: SettingsSectionsBackend) => SettingsSectionsHarness | Promise<SettingsSectionsHarness>

ui/src/settings/testing/sections.contract.ts:88

Functions#

describeSettingsAccountsContractFunction#

Parameters

describeSettingsClaudeImportContractFunction#

Parameters

describeSettingsExtensionOptionsContractFunction#

Parameters

describeSettingsHostContractFunction#

Parameters

describeSettingsModelsContractFunction#

Parameters

describeSettingsPerformanceContractFunction#

Parameters

describeSettingsSectionsContractFunction#

Parameters

Constants#

ACCOUNTS_CONTRACT_CWDConstant#

Interfaces#

SettingsAccountsBackendInterface#

Properties

SettingsAccountsControlInterface#

Properties

SettingsAccountsHarnessInterface#

Properties

SettingsClaudeImportBackendInterface#

Properties

SettingsClaudeImportHarnessInterface#

Properties

SettingsExtensionOptionsBackendInterface#

Properties

SettingsExtensionOptionsHarnessInterface#

Properties

SettingsHostContractBackendInterface#

Properties

SettingsHostContractControlInterface#

Properties

SettingsHostContractTraitsInterface#

Properties

SettingsHostHarnessInterface#

Properties

SettingsModelsBackendInterface#

Properties

SettingsModelsHarnessInterface#

Properties

SettingsPerformanceBackendInterface#

Properties

SettingsPerformanceContractOptionsInterface#

Properties

SettingsPerformanceControlInterface#

Properties

SettingsPerformanceHarnessInterface#

Properties

SettingsSectionsBackendInterface#

Properties

SettingsSectionsControlInterface#

Properties

SettingsSectionsHarnessInterface#

Properties

Types#

SettingsAccountsCapabilityType#

SettingsAccountsHarnessFactoryType#

SettingsClaudeImportHarnessFactoryType#

SettingsExtensionOptionsCapabilityType#

SettingsExtensionOptionsHarnessFactoryType#

SettingsHostCapabilityType#

SettingsHostHarnessFactoryType#

SettingsModelsCapabilityType#

SettingsModelsHarnessFactoryType#

SettingsPerformanceCapabilityType#

SettingsPerformanceHarnessFactoryType#

SettingsSectionsCapabilityType#

SettingsSectionsHarnessFactoryType#

`describeSettingsAccountsContract`Function#

`describeSettingsClaudeImportContract`Function#

`describeSettingsExtensionOptionsContract`Function#

`describeSettingsHostContract`Function#

`describeSettingsModelsContract`Function#

`describeSettingsPerformanceContract`Function#

`describeSettingsSectionsContract`Function#

`ACCOUNTS_CONTRACT_CWD`Constant#

`SettingsAccountsBackend`Interface#

`SettingsAccountsControl`Interface#

`SettingsAccountsHarness`Interface#

`SettingsClaudeImportBackend`Interface#

`SettingsClaudeImportHarness`Interface#

`SettingsExtensionOptionsBackend`Interface#

`SettingsExtensionOptionsHarness`Interface#

`SettingsHostContractBackend`Interface#

`SettingsHostContractControl`Interface#

`SettingsHostContractTraits`Interface#

`SettingsHostHarness`Interface#

`SettingsModelsBackend`Interface#

`SettingsModelsHarness`Interface#

`SettingsPerformanceBackend`Interface#

`SettingsPerformanceContractOptions`Interface#

`SettingsPerformanceControl`Interface#

`SettingsPerformanceHarness`Interface#

`SettingsSectionsBackend`Interface#

`SettingsSectionsControl`Interface#

`SettingsSectionsHarness`Interface#

`SettingsAccountsCapability`Type#

`SettingsAccountsHarnessFactory`Type#

`SettingsClaudeImportHarnessFactory`Type#

`SettingsExtensionOptionsCapability`Type#

`SettingsExtensionOptionsHarnessFactory`Type#

`SettingsHostCapability`Type#

`SettingsHostHarnessFactory`Type#

`SettingsModelsCapability`Type#

`SettingsModelsHarnessFactory`Type#

`SettingsPerformanceCapability`Type#

`SettingsPerformanceHarnessFactory`Type#

`SettingsSectionsCapability`Type#

`SettingsSectionsHarnessFactory`Type#