Tutorial: How to link to Laravel JetStream Teams

[dalehurleygreener]

Wanted to share for others how I managed to link laravel-xero-oauth2 with Laravel JetStream Teams.

Assuming you have already followed the Installation instructions.

1. Add the xero_oauth JSON cast to Team Model.

    protected function casts(): array
    {
        return [
            'personal_team' => 'boolean',
            'xero_oauth' => 'json'
        ];
    }

2. Bind the TeamStorageProvider (to be created) to the AppServiceProvider

use App\Models\Team;
use App\Xero\TeamStorageProvider;
...

class AppServiceProvider extends ServiceProvider
{
   ...
    public function boot(): void
    {
        //
        $this->app->bind(OauthCredentialManager::class, function(Application $app) {
            return new TeamStorageProvider(
                \Auth::user()->currentTeam, // Storage Mechanism
                $app->make('session.store'), // Used for storing/retrieving oauth 2 "state" for redirects
                $app->make(\Webfox\Xero\Oauth2Provider::class) // Used for getting redirect url and refreshing token
            );
        });
    }
}

3. Create the migration to add the xero_oauth field to the teams table

# php artisan make:migration AddXeroOauthToTeams

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::table('teams', function (Blueprint $table) {
            // add the xero_oauth json column
            $table->json('xero_oauth')->nullable();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('teams', function (Blueprint $table) {
            // drop the xero_oauth json column
            $table->dropColumn('xero_oauth');
        });
    }
};

5. Run the migration php artisan migrate

6. Create the /App/Xero/TeamStorageProvider.php

<?php

namespace App\Xero;

use App\Models\Team;
use Illuminate\Session\Store;
use League\OAuth2\Client\Token\AccessTokenInterface;
use Webfox\Xero\Oauth2Provider;
use Webfox\Xero\Oauth2CredentialManagers\FileStore;

class TeamStorageProvider extends FileStore
{

   /** @var Team */
    protected $team;

    public function __construct(Team $team, Store $session, Oauth2Provider $oauthProvider)
    {
        $this->team           = $team;
        $this->oauthProvider = $oauthProvider;
        $this->session       = $session;
    }

    public function exists(): bool
    {
        return !!$this->team->xero_oauth;
    }

    public function store(AccessTokenInterface $token, array $tenants = null): void
    {
        $this->team->xero_oauth = [
            'token'         => $token->getToken(),
            'refresh_token' => $token->getRefreshToken(),
            'id_token'      => $token->getValues()['id_token'],
            'expires'       => $token->getExpires(),
            'tenants'       => $tenants ?? $this->getTenants()
        ];

        $this->team->saveOrFail();
    }

    public function delete(): void
    {
        $this->team->xero_oauth = null;
        $this->team->saveOrFail();
    }

    protected function data($key = null)
    {
        if (!$this->exists()) {
            throw new \Exception('Xero oauth credentials are missing');
        }

        $cacheData = $this->team->xero_oauth;

        return empty($key) ? $cacheData : ($cacheData[$key] ?? null);
    }
}

[hailwood]

Thanks @dalehurleygreener,

I've enabled discussions on this project now so we can hopefully gather up all the fantastic guides like yours :)

[dalehurleygreener]

Happy to help