Intent Vocabulary

The built-in intent vocabulary maps common user action names to sensible contract defaults. Providing an intent prop at Level 1 adoption automatically fills safety level, reversibility, and confirmation requirements from these defaults.

Built-in Intents

25 intents total. Filter by name to find what you need.

Intent	Safety Level	Reversible	Requires Confirmation	Destructive
place-order	high	yes	yes	no
make-payment	critical	no	yes	no
delete-account	critical	no	yes	yes
delete-item	high	no	yes	yes
send-message	medium	no	no	no
save-draft	low	yes	no	no
submit-form	medium	no	no	no
update-profile	medium	yes	no	no
sign-out	low	yes	no	no
sign-in	low	yes	no	no
apply-filter	low	yes	no	no
search	low	yes	no	no
upload-file	medium	yes	no	no
download-file	low	yes	no	no
schedule-meeting	medium	yes	no	no
cancel-booking	high	no	yes	no
publish-content	high	yes	yes	no
unpublish-content	high	yes	yes	no
share-item	medium	yes	no	no
navigate	low	yes	no	no
confirm-action	high	no	yes	no
collect-email	low	yes	no	no
collect-password	sensitive	yes	no	no
collect-payment	sensitive	no	yes	no
authenticate	medium	yes	no	no

Registering Custom Intents

Use registerIntent() to extend the built-in vocabulary with domain-specific intents. Once registered, the intent is recognized by isKnownIntent(), and its defaults are automatically merged when a developer uses the intent at Level 1 or Level 2 adoption.

import { registerIntent } from '@vhyxseal/core'

// Register a domain-specific intent with custom defaults
registerIntent("request-refund", {
  safetyLevel: "high",
  reversible: false,
  requiresConfirmation: true,
  destructive: false,
})

// The intent is now available for components:
// <Button intent="request-refund">Request Refund</Button>
// Library merges your registered defaults — no other fields required

Custom intents are appropriate when your domain has actions that don't map cleanly to the built-in vocabulary — for example, request-refund, approve-document, or archive-record. Keep intent names lowercase, hyphen-separated, and descriptive of the action from the user's perspective. Intent names must be 50 characters or fewer.