[Traits](https://oods-foundry.com/traits) / Preferenceable

# Preferenceable

User preference trait backed by JSONB storage, schema versioning, and registry governance.

Generated from @oods/foundry 0.10.1

- Group

  core

- Maturity

  experimental

- Contexts

  detail, form, list

Encodes namespaces such as theme, notifications, and display with deterministic overrides.

## Fields it adds

| Field | Type | Required | Description |
| - | - | - | - |
| `preference_document` | `PreferenceDocument` | yes | Normalized preference payload captured by PreferenceStore (version, preferences map, metadata). |
| `preference_metadata` | `PreferenceMetadata` | yes | Tracks schema version, lastUpdated timestamp, migration records, and source. |
| `preference_version` | `string` | yes | SemVer mirror of preference_document.version for indexing and analytics. |
| `preference_namespaces` | `string[]` | yes | Materialized namespace list resolved from parameters/registry for auditing. |
| `preference_mutations` | `number` | no | Monotonic counter incremented whenever preferences mutate (invalidates caches). |

## What it shows in each context

- [list](https://oods-foundry.com/contexts/list)

  `PreferenceSummaryBadge`

- [detail](https://oods-foundry.com/contexts/detail)

  `PreferencePanel`

- [form](https://oods-foundry.com/contexts/form)

  `PreferenceEditor`

## Parameters

- `namespaces` `string[]`, required

  Allowed top-level namespaces for preference keys (theme, notifications, display, etc.).

- `schemaVersion` `string`, required

  Current JSON Schema version served by the registry for validation and UI generation.

- `allowUnknownNamespaces` `boolean`

  Escape hatch allowing writes outside the declared namespace allow list.

- `registryNamespace` `string`

  Registry identifier used to fetch JSON Schema and uiSchema bundles.

## Objects that use it

- [Organization](https://oods-foundry.com/objects/organization)
- [User](https://oods-foundry.com/objects/user)

## The trait file

`traits/core/Preferenceable.trait.yaml`

```
trait:
  name: Preferenceable
  version: 1.0.0
  description: >
    User preference trait backed by JSONB storage, schema versioning, and registry governance.
    Encodes namespaces such as theme, notifications, and display with deterministic overrides.
  category: core
  tags:
    - preferences
    - jsonb
    - schema-evolution
    - user-settings
    - notification

parameters:
  - name: namespaces
    type: string[]
    required: true
    description: Allowed top-level namespaces for preference keys (theme, notifications, display, etc.).
    default:
      - theme
      - notifications
      - display
    validation:
      minItems: 1
      maxItems: 12
      uniqueItems: true
      items:
        pattern: "^[a-z0-9._-]+$"
        minLength: 2
        maxLength: 48
  - name: schemaVersion
    type: string
    required: true
    description: Current JSON Schema version served by the registry for validation and UI generation.
    default: 1.0.0
    validation:
      pattern: "^\\d+\\.\\d+\\.\\d+$"
  - name: allowUnknownNamespaces
    type: boolean
    required: false
    description: Escape hatch allowing writes outside the declared namespace allow list.
    default: false
  - name: registryNamespace
    type: string
    required: false
    description: Registry identifier used to fetch JSON Schema and uiSchema bundles.
    default: user-preferences
    validation:
      pattern: "^[a-z0-9._-]+$"

schema:
  preference_document:
    type: PreferenceDocument
    required: true
    description: Normalized preference payload captured by PreferenceStore (version, preferences map, metadata).
    default:
      version: 1.0.0
      preferences:
        theme:
          mode: system
        notifications:
          mention:
            email: true
            push: true
      metadata:
        schemaVersion: 1.0.0
        lastUpdated: "2025-11-18T00:00:00Z"
        source: system
        migrationApplied: []
  preference_metadata:
    type: PreferenceMetadata
    required: true
    description: Tracks schema version, lastUpdated timestamp, migration records, and source.
  preference_version:
    defaultFromParameter: schemaVersion
    type: string
    required: true
    description: SemVer mirror of preference_document.version for indexing and analytics.
    validation:
      pattern: "^\\d+\\.\\d+\\.\\d+$"
  preference_namespaces:
    defaultFromParameter: namespaces
    type: string[]
    required: true
    description: Materialized namespace list resolved from parameters/registry for auditing.
    default:
      - theme
      - notifications
      - display
  preference_mutations:
    type: number
    required: false
    description: Monotonic counter incremented whenever preferences mutate (invalidates caches).
    default: 0
    validation:
      minimum: 0

semantics:
  preference_document:
    semantic_type: preferences.document
    token_mapping: tokenMap(preferences.document)
    ui_hints:
      component: PreferenceDiffPanel
      registryNamespaceParameter: registryNamespace
  preference_metadata:
    semantic_type: preferences.metadata
    token_mapping: tokenMap(preferences.metadata)
    ui_hints:
      component: PreferenceDiagnostics
  preference_version:
    semantic_type: preferences.version
    token_mapping: tokenMap(preferences.version)
    ui_hints:
      component: PreferenceVersionBadge
  preference_namespaces:
    semantic_type: preferences.namespaces
    token_mapping: tokenMap(preferences.namespaces)
    ui_hints:
      component: PreferenceNamespaceChips

view_extensions:
  list:
    - component: PreferenceSummaryBadge
      position: after
      props:
        namespacesField: preference_namespaces
        versionField: preference_version
  detail:
    - component: PreferencePanel
      position: main
      priority: 55
      props:
        preferencesField: preference_document
        metadataField: preference_metadata
        namespaceField: preference_namespaces
  form:
    - component: PreferenceEditor
      position: main
      props:
        namespacesField: preference_namespaces
        documentField: preference_document
        registryNamespaceParameter: registryNamespace

tokens:
  preferences.panel.bg: "var(--sys-surface-raised)"
  preferences.panel.border: "var(--sys-border-strong)"
  preferences.namespace.badge.bg: "var(--sys-surface-muted)"
  preferences.namespace.badge.text: "var(--sys-text-strong)"

dependencies: []

metadata:
  created: "2025-11-18"
  owners:
    - core@oods.systems
    - platform@oods.systems
  maturity: experimental
  accessibility:
    keyboard: PreferenceEditor supports namespace-by-namespace keyboard traversal with aria landmarks.
    screenreader: PreferencePanel announces namespace and control labels derived from JSON Schema titles.
  regionsUsed:
    - list
    - detail
    - form
  examples:
    - User
    - Subscription
  references:
    - "R21.5 Preferenceable Trait Implementation"
    - "objects/provenance.v1.json#/references/ref-2181d6411382"
```