package vault

import "errors"

// Sentinel errors returned by vault operations.
//
// Several of these carry deliberately partial text: the message a caller
// composes with fmt.Errorf places the interpolated value where it has
// always appeared, and the sentinel supplies only the surrounding fixed
// words. This keeps every composed message byte-identical to the dynamic
// errors these sentinels replaced. Each such sentinel notes the message it
// participates in.
var (
	// ErrMnemonicMismatch indicates the mnemonic-derived public key does
	// not match the vault's stored public key hash.
	ErrMnemonicMismatch = errors.New(
		"derived public key does not match vault: mnemonic may be incorrect",
	)

	// ErrInvalidVaultName indicates a vault name that does not match the
	// allowed pattern [a-z0-9.\-_]+. Composed as
	// "invalid vault name '<name>': must match pattern [a-z0-9.\-_]+".
	ErrInvalidVaultName = errors.New("invalid vault name")

	// ErrVaultNotFound indicates the named vault does not exist. Composed
	// as "vault <name> does not exist".
	ErrVaultNotFound = errors.New("does not exist")

	// ErrNilValueBuffer indicates a nil value buffer was supplied.
	ErrNilValueBuffer = errors.New("value buffer is nil")

	// ErrInvalidSecretName indicates a secret name that does not match
	// the allowed pattern [a-z0-9.\-_/]+. Composed as
	// "invalid secret name '<name>': must match pattern [a-z0-9.\-_/]+",
	// or as "invalid secret name: <name>" by GetSecretObject.
	ErrInvalidSecretName = errors.New("invalid secret name")

	// ErrSecretExists indicates the secret already exists and --force
	// was not supplied. Composed as
	// "secret <name> already exists (use --force to overwrite)", or as
	// "secret '<name>' already exists in vault '<vault>' (use --force to
	// overwrite)" when copying between vaults.
	ErrSecretExists = errors.New("already exists")

	// ErrSecretNotFound indicates the named secret does not exist.
	// Composed as "secret <name> not found".
	ErrSecretNotFound = errors.New("not found")

	// ErrVersionNotFound indicates the requested secret version does not
	// exist. Composed as
	// "version <version> not found for secret <name>".
	ErrVersionNotFound = errors.New("not found for secret")

	// ErrNoVersions indicates the source secret has no versions. Composed
	// as "source secret '<name>' has no versions".
	ErrNoVersions = errors.New("has no versions")

	// ErrUnsupportedUnlockerType indicates an unlocker metadata type
	// that this build does not support.
	ErrUnsupportedUnlockerType = errors.New("unsupported unlocker type")

	// ErrUnlockerNotFound indicates no unlocker with the given ID exists.
	// Composed as "unlocker with ID <id> not found".
	ErrUnlockerNotFound = errors.New("not found")
)