Configuration

The published config/addresses.php in full (comments trimmed):

use RoundlyConsulting\Addresses\Address;
use RoundlyConsulting\Addresses\Enums\AddressType;

return [
    'model' => Address::class,

    'key_type' => env('ADDRESSES_KEY_TYPE', 'bigint'),   // bigint | uuid | ulid

    'types' => [
        AddressType::Default->value,
        AddressType::Billing->value,
        AddressType::Shipping->value,
        AddressType::Home->value,
        AddressType::Work->value,
        AddressType::Office->value,
    ],

    'default_type' => AddressType::Default->value,

    'normalise_country' => true,

    'country_resolver' => null,

    'facade_alias' => 'Addresses',
];

Every key

Environment

Only the owner key type is env-backed — the other keys are literal values you change in the published file:

ADDRESSES_KEY_TYPE=uuid

types

types is the allow-list of address types. It ships the six AddressType values, so nothing changes until you set it; once you do, it is the whole list — a built-in you leave out is refused like an unknown key. Custom keys need no migration, since the type column is a plain string. See Address types:

// config/addresses.php — the whole allow-list: a built-in you leave out is refused too
'types' => [
    'default',
    'billing',
    'registered' => 'Registered office',          // a type and its label
    'postal',                                     // labelled "Postal"
    'operating' => ['label' => 'Operating site'],
],

default_type

default_type is the type an address gets when its creator names none — the fluent builder without ->type(), AddressData without type and createAddress() without type all fall back to it, and a key that is not set (absent, null or blank) means AddressType::Default. It may name any configured type, built-in or custom. It is read when such an address is built — matching ignores case and padding — so a value that is not in types throws InvalidAddressTypeException at that point:

// config/addresses.php
'default_type' => 'billing',   // or a custom key listed in 'types'

// an address created without a type now gets AddressType::Billing
$customer->newAddress()
    ->in('Bratislava')->at('Somewhere 1')->postalCode('81101')->country('SK')
    ->save();

facade_alias

Set facade_alias to another name (for example Locations) to register the facade under that alias, or to null (or a false spelling: false, 0, off, no) to skip the alias entirely; a blank value is not set and keeps Addresses. The alias comes from config only — the package’s composer.json declares none for package discovery — and importing RoundlyConsulting\Addresses\Facades\Addresses works either way.