Configuration

The published config/contacts.php:

return [
    'model' => RoundlyConsulting\Contacts\Models\Contact::class,
    'table' => 'contacts',
    'key_type' => env('CONTACTS_KEY_TYPE', 'bigint'),

    'auto_primary' => true,
    'require_owner_for_primary' => false,
    'default_country_code' => env('CONTACTS_DEFAULT_COUNTRY_CODE'),

    'verification' => [
        'ttl' => env('CONTACTS_VERIFICATION_TTL', 60),
        'style' => env('CONTACTS_VERIFICATION_STYLE', 'code'),
        'code_length' => env('CONTACTS_VERIFICATION_CODE_LENGTH', 6),
        'token_length' => env('CONTACTS_VERIFICATION_TOKEN_LENGTH', 32),
        'max_attempts' => env('CONTACTS_VERIFICATION_MAX_ATTEMPTS', 5),
    ],

    'types' => [
        // 'whatsapp' => ['label' => 'WhatsApp', 'icon' => 'chat', 'rules' => ['required', 'string']],
    ],

    'relationship_kinds' => [
        // 'works_at' => 'Works at', 'spouse_of' => 'Spouse of',
    ],
];

Every key

The two switches accept env-style strings ('true'/'false', '1'/'0', 'on'/'off', 'yes'/'no'), and the numeric keys accept integer strings ('30'). A key that is not set (absent, null, or blank: '' or whitespace, as a bare CONTACTS_VERIFICATION_TTL= line gives) takes its default. Anything else — a mistyped switch or style, a TTL, length or attempt count that is not a whole number ('five', '5.5') or is out of range, a non-string table, a country code that isn’t one, a malformed types or relationship_kinds entry — throws the package toolkit’s InvalidConfigurationException naming the key, rather than being read as a default or clamped.

Environment

The deployment-sensitive keys are env-backed, so you rarely need to publish the file:

CONTACTS_KEY_TYPE=bigint
CONTACTS_DEFAULT_COUNTRY_CODE=421
CONTACTS_VERIFICATION_TTL=60
CONTACTS_VERIFICATION_STYLE=code
CONTACTS_VERIFICATION_CODE_LENGTH=6
CONTACTS_VERIFICATION_TOKEN_LENGTH=32
CONTACTS_VERIFICATION_MAX_ATTEMPTS=5

Custom contact model

The Contact model is intentionally not final. Extend it and point contacts.model at your class — the trait, actions, vCard exporter, notification routing and test matchers all resolve it from there:

namespace App\Models;

use RoundlyConsulting\Contacts\Models\Contact as BaseContact;

class Contact extends BaseContact
{
    // your own relations, accessors and scopes
}

// config/contacts.php
'model' => App\Models\Contact::class,

The configured class must be the package’s Contact or a subclass of it; anything else — a foreign model, a class that doesn’t exist — throws InvalidConfigurationException naming contacts.model instead of being silently replaced. Change the table through contacts.table rather than a $table property — the model’s getTable() honours the config value.

Inspecting the configuration

The package reports its configuration to Laravel’s about command:

php artisan about --only=contacts

Registered kinds and relationship kinds are your domain vocabulary, so they are reported as counts only — never by name. The country code is reported by presence, never its value. A malformed table, country code, verification setting, types or relationship_kinds value shows as INVALID instead of failing the command.