Package Development

mkdir -p packages/my-module/{src/{Providers,Http/Controllers,Http/Requests,Http/Resources,Models,Services,Policies,Enums,Contracts,Traits},database/migrations,lang/{en,fr},config}

{
  "name": "exowpee/my-module",
  "description": "My Module for Exowpee",
  "type": "library",
  "require": {
    "php": "^8.2",
    "exowpee/shared": "*"
  },
  "autoload": {
    "psr-4": {
      "Exowpee\\MyModule\\": "src/"
    }
  },
  "extra": {
    "laravel": {
      "providers": [
        "Exowpee\\MyModule\\Providers\\MyModuleServiceProvider"
      ]
    }
  }
}

<?php
// packages/my-module/src/Providers/MyModuleServiceProvider.php

namespace Exowpee\MyModule\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Gate;
use Exowpee\MyModule\Models\MyModel;
use Exowpee\MyModule\Policies\MyModelPolicy;
use Exowpee\MyModule\Contracts\MyModuleInterface;
use Exowpee\MyModule\Services\MyModuleService;

class MyModuleServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        $this->loadRoutesFrom(__DIR__ . '/../Http/routes.php');
        $this->loadMigrationsFrom(__DIR__ . '/../../database/migrations');
        $this->loadTranslationsFrom(__DIR__ . '/../../lang', 'my-module');

        Gate::policy(MyModel::class, MyModelPolicy::class);
    }

    public function register(): void
    {
        $this->app->bind(MyModuleInterface::class, MyModuleService::class);
    }
}

<?php
// packages/my-module/src/Http/routes.php

use Exowpee\MyModule\Http\Controllers\MyController;
use Illuminate\Support\Facades\Route;

Route::group([
    'prefix' => 'v1/my-module',
    'as' => 'exowpee.my-module.',
    'middleware' => 'exowpee.teams',
], function () {
    Route::group([
        'middleware' => 'exowpee.company',
    ], function () {
        Route::apiResource('items', MyController::class);
    });
});

<?php
namespace Exowpee\MyModule\Models;

use Exowpee\Shared\Traits\KsuidTrait;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use KsuidTrait;

    protected $fillable = [
        'name',
        'description',
        'company_id',
        'organization_id',
    ];
}

php artisan make:migration create_my_models_table --path=packages/my-module/database/migrations

Schema::create('my_models', function (Blueprint $table) {
    $table->string('id')->primary();  // KSUID
    $table->string('name');
    $table->text('description')->nullable();
    $table->string('company_id')->index();
    $table->string('organization_id')->index();
    $table->timestamps();
});

<?php
namespace Exowpee\MyModule\Policies;

use Exowpee\Shared\Traits\BeforePolicyFilterTrait;
use Exowpee\MyModule\Models\MyModel;

class MyModelPolicy
{
    use BeforePolicyFilterTrait;

    public function viewAny($user): bool
    {
        return (bool) auth()->profile()?->hasPermissionTo('my-module.list');
    }

    public function create($user): bool
    {
        return (bool) auth()->profile()?->hasPermissionTo('my-module.create');
    }

    public function update($user, MyModel $model): bool
    {
        return auth()->profile()?->hasPermissionTo('my-module.update')
            && $model->organization_id === getTeamOrganization()->id;
    }
}

{
  "repositories": [
    { "type": "path", "url": "packages/my-module" }
  ],
  "require": {
    "exowpee/my-module": "*"
  }
}

composer update exowpee/my-module

php artisan migrate