prepare for new release

Author: Jurager

README.md

@@ -14,6 +14,7 @@ You can add a user to a global group to grant them access to all teams with the
 > The documentation for this package is currently being written. For now, please refer to this readme for information on the functionality and usage of the package.
 
 - [Requirements](#requirements)
+- [Schema](#schema)
 - [Installation](#installation)
 - [Actions](#actions)
 - [Teams](#teams)
@@ -39,6 +40,10 @@ Requirements
 -------------------------------------------
 `PHP >= 8.1` and `Laravel 8.x or higher`
 
+Schema
+-------------------------------------------
+![Schema](schema.png "Title")
+
 Installation
 -------------------------------------------
 
@@ -100,49 +105,49 @@ $team->users()
 $team->allUsers()
 
 // Determine if the given user is a team member...
-$team->hasUser((object) $user)
+$team->hasUser(object $user)
 
 // Get all the abilities belong to the team.
 $team->abilities()
 
 // Get all the team's roles.
 $team->roles()
 
-// Get the role from the team by role id or name 
-$team->findRole((int|string) $id)
-
 // Return the user role object from the team
-$team->userRole((object) $user)
+$team->userRole(object $user)
+
+// Get the role from the team by role id or code 
+$team->getRole(int|string $keyword)
 
 // Add new role to the team
-$team->addRole((string) $code, (array) $capabilities)
+$team->addRole(string $code, array $capabilities)
 
 // Update the role in the team
-$team->updateRole((string) $code, (array) $capabilities)
+$team->updateRole(string $code, array $capabilities)
 
 // Deletes the given role from team
-$team->deleteRole((string) $code)
+$team->deleteRole(string $code)
 
 // Get all groups of the team.
 $team->groups()
 
-// Get team group by its code
-$team->group((string) $code)
+// Get team group by its id or code
+$team->getGroup(int|string $keyword)
 
 // Add new group to the team
-$team->addGroup((string) $code, (string) $name)
+$team->addGroup(string $code, string $name)
 
 // Delete group from the team
-$team->deleteGroup((string) $code)
+$team->deleteGroup(string $code)
 
 // Determine if the team has a member with the given email address...
-$team->hasUserWithEmail((array) $emailAddress)
+$team->hasUserWithEmail(array $email)
 
 // Determine if the given user is a team member with the given permission...
-$team->userHasPermission((object) $user, (string|array) $permission, (bool) $require = false)
+$team->userHasPermission(object $user, string|array $permission, bool $require = false)
 
 // Remove the given user from the team.
-$team->deleteUser((object) $user);
+$team->deleteUser(object $user);
 
 // Determine if the team has a member with the given email address...
 $team->invitations()
@@ -169,34 +174,34 @@ $user->ownedTeams : Illuminate\Database\Eloquent\Collection
 $user->allTeams() : Illuminate\Database\Eloquent\Collection
 
 // Determine if a user owns a given team...
-$user->ownsTeam((object) $team) : bool
+$user->ownsTeam(object $team) : bool
 
 // Determine if a user belongs to a given team...
-$user->belongsToTeam((object) $team) : bool
+$user->belongsToTeam(object $team) : bool
 
 // Get the role that the user is assigned on the team...
-$user->teamRole((object) $team) : \Jurager\Teams\Role
+$user->teamRole(object $team) : \Jurager\Teams\Role
 
 // Determine if the user has the given role on the given team...
-$user->hasTeamRole((object) $team, (string|array) 'admin', (bool) $require = false) : bool
+$user->hasTeamRole(object $team, string|array 'admin', bool $require = false) : bool
 
 // Access an array of all permissions a user has for a given team...
-$user->teamPermissions((object) $team) : array
+$user->teamPermissions(object $team) : array
 
 // Determine if a user has a given team permission...
-$user->hasTeamPermission((object) $team, (string|array) 'server:create', (bool) $require = false) : bool
+$user->hasTeamPermission(object $team, string|array 'server:create', bool $require = false) : bool
 
 // Get list of abilities or forbidden abilities for users on certain model
-$user->teamAbilities((object) $team, (object) $server) : mixed
+$user->teamAbilities(object $team, object $server) : mixed
 
 // Determine if a user has a given ability on certain model...
-$user->hasTeamAbility((object) $team, (string) 'server:edit', (object) $server) : bool
+$user->hasTeamAbility(object $team, string 'server:edit', object $server) : bool
 
 // Add an ability for user to action on certain model, if permission is not found, will create a new one
-$user->allowTeamAbility((object) $team, (string) 'server:edit', (object) $server) : bool
+$user->allowTeamAbility(object $team, string 'server:edit', object $server) : bool
 
 // Forbid an ability for user to action on certain model, used in case if global permission or role allowing this action
-$user->forbidTeamAbility((object) $team, (string) 'server:edit', (object) $server) : bool
+$user->forbidTeamAbility(object $team, string 'server:edit', object $server) : bool
 ```
 
 These methods enable you to efficiently manage and inspect a user's teams, roles, permissions, and abilities within your application.
@@ -221,25 +226,25 @@ The `Jurager\Teams\Traits\HasTeams` trait provides methods to inspect a user's t
 
 ```php
 // Add new group to the team
-$team->addGroup((string) $code, (string) $name)
+$team->addGroup(string $code, string $name)
 
 // Delete group from the team
-$team->deleteGroup((string) $code)
+$team->deleteGroup(string $code)
 
 // Get all groups of the team.
 $team->groups();
 
 // Get team group by its code
-$team->group((string) $code);
+$team->getGroup(int|string $keyword);
 
 // Get all group users
-$team->group((string) $code)->users();
+$team->getGroup(int|string $keyword)->users();
 
 // Attach users or user to a group
-$team->group((string) $code)->attachUser((Collection|Model) $user);
+$team->getGroup(int|string $keyword)->attachUser(Collection|Model $user);
 
 // Detach users or user from group
-$team->group((string) $code)->detachUser((Collection|Model) $user);
+$team->getGroup(int|string $keyword)->detachUser(Collection|Model $user);
 ```
 
 ### Groups Permissions
@@ -248,20 +253,20 @@ You can manage permissions within a group using the following methods:
 
 ```php
 // Add an ability for user to action on certain model within team group, if permission is not found, will create a new one
-$user->allowTeamAbility((object) $team, (string) 'server:edit', (object) $server, (object|null) $group));
+$user->allowTeamAbility(object $team, string 'server:edit', object $server, object|null $group));
 
 // Forbid an ability for user to action on certain model within team group
-$user->forbidTeamAbility((object) $team, (string) 'server:edit', (object) $server, (object|null) $group);
+$user->forbidTeamAbility(object $team, string 'server:edit', object $server, object|null $group);
 
 // Delete user ability to action on certain model within team group
-$user->deleteTeamAbility((object) $team, (string) 'server:edit', (object) $server, (object|null) $group);
+$user->deleteTeamAbility(object $team, string 'server:edit', object $server, object|null $group);
 ```
 > [!NOTE]
 > Team groups work together with abilities, so you should use ability checking methods to determine if users have specific access rights within groups.
 
 ```php
 // Determinate if user can perform an action
-$user->hasTeamAbility((object) $team, (string) 'server:edit', (object) $server)
+$user->hasTeamAbility(object $team, string 'server:edit', object $server)
 ```
 
 Middleware `ability` is used to check the user's rights within the team group during requests to your application
@@ -322,7 +327,7 @@ To ensure that incoming requests initiated by a team member can be executed by t
 > In most cases, it's unnecessary to check a user's role directly. Instead, focus on verifying specific granular permissions. Roles primarily serve as a way to group granular permissions for organizational purposes. Typically, you'll execute calls to this method within your application's [authorization policies](https://laravel.com/docs/authorization#creating-policies).
 
 ```php
-return $user->hasTeamPermission((string) $server->team, (string) 'server:update');
+return $user->hasTeamPermission(string $server->team, string 'server:update');
 ```
 
 This example demonstrates how to check if a user within a team has permission to update a server. Adjust the parameters according to your application's specific requirements and use cases.
@@ -340,23 +345,23 @@ Simply pass the name of the ability, and the package will create it if it's not
 To add the ability to edit an article within a team for a specific user, you need to provide the entity, such as the article object, and the team object:
 
 ```php
-User::allowTeamAbility((object) $team, string 'edit', (object) $article, (object|null) $group);
+User::allowTeamAbility(object $team, string 'edit', object $article, object|null $group);
 ```
 
 ### Checking an Ability
 
 To check if a user has a specific ability in a team, you can use the following method:
 
 ```php
-User::hasTeamAbility((object) $team, string 'edit', (object) $article);
+User::hasTeamAbility(object $team, string 'edit', object $article);
 ```
 
 ### Forbidding an Ability
 
 If you need to forbid a user from having a certain ability for instance, if the role abilities allow this ability, you can do so using the following method:
 
 ```php
-User::forbidTeamAbility((object) $team, (string) 'edit', (object) $article, (object|null) $group);
+User::forbidTeamAbility(object $team, string 'edit', object $article, object|null $group);
 ```
 
 ### Creating Abilities
@@ -445,4 +450,4 @@ In this case, pass `article_id` as a request parameter or route parameter to all
 
 ## License
 
-This package is open-sourced software licensed under the [MIT license](LICENSE.md).
+This package is open-sourced software licensed under the [MIT license](LICENSE.md).

config/teams.php

@@ -71,6 +71,23 @@
         'team_id' => 'team_id',
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Invitations
+    |--------------------------------------------------------------------------
+    | Configures the team invitation feature, allowing users to be invited to join teams.
+    */
+    'invitations' => [
+
+        'enabled' => true,
+
+        'routes' => [
+            'register' => true,
+            'url' => '/invitation/accept',
+            'middleware' => 'web'
+        ]
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | Support

database/migrations/add_fields_to_users_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up(): void
+    {
+        Schema::table('users', static function (Blueprint $table) {
+            $table->boolean(config('teams.support_field', 'is_support'))->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down(): void
+    {
+        Schema::table('users', static function (Blueprint $table) {
+            $table->dropColumn(config('teams.support_field', 'is_support'));
+        });
+    }
+};

database/migrations/0001_01_06_000000_create_abilities_table.php renamed to database/migrations/create_abilities_table.php

@@ -1,9 +1,29 @@
-{{ __('You have been invited to join the :team team!', ['team' => $invitation->team->name]) }}
+<div style="font-family: Arial, sans-serif; background-color: #f3f4f6; padding: 20px; margin: auto; color: #333;">
+    <!-- Header -->
+    <div style="text-align: center; padding: 20px 0;">
+        <h2 style="color: #333333; font-size: 28px; margin-bottom: 10px;">
+            {{ __('You’re Invited to Join the :team Team!', ['team' => $invitation->team->name]) }}
+        </h2>
+        <p style="font-size: 16px; color: #666666; margin: 0;">
+            {{ __('We are thrilled to have you with us! Follow the instructions below to join our team.') }}
+        </p>
+    </div>
 
-{{ __('If you do not have an account, you may create one by clicking the button below. After creating an account, you may click the invitation acceptance button in this email to accept the team invitation:') }}
+    <!-- Invitation Info -->
+    <p style="font-size: 15px; color: #555555; line-height: 1.7;">
+        {{ __('If you already have an account or create one using the provided link, click below to accept the invitation and join the team!') }}
+    </p>
 
-{{ __('Create Account') }}
+    <!-- Accept Invitation Button -->
+    <div style="margin-top: 20px; text-align: center;">
+        <a href="{{ $url }}" style="display: inline-block; padding: 12px 28px; font-size: 16px; font-weight: bold; color: #ffffff; background-color: #28a745; border-radius: 6px; text-decoration: none; box-shadow: 0 4px 8px rgba(40, 167, 69, 0.3);">
+            {{ __('Accept Invitation') }}
+        </a>
+    </div>
 
-{{ __('If you already have an account, you may accept this invitation by clicking the button below:') }}
-
-{{ __('Accept Invitation') }}
+    <!-- Footer -->
+    <div style="margin-top: 30px; text-align: center; font-size: 14px; color: #999999;">
+        <p>{{ __('If you have any questions, feel free to reach out to our support team.') }}</p>
+        <p>{{ __('Best regards,') }}<br><strong>{{ config('app.name') }}</strong></p>
+    </div>
+</div>

database/migrations/0001_01_02_000000_create_capabilities_table.php renamed to database/migrations/create_capabilities_table.php

@@ -0,0 +1,8 @@
+<?php
+
+use App\Http\Controllers\InviteController;
+use Illuminate\Support\Facades\Route;
+
+Route::middleware(config('teams.invitations.routes.middleware'))
+    ->get(config('teams.invitations.routes.url'), [InviteController::class, 'inviteAccept'])
+    ->name('teams.invitations.accept');

database/migrations/0001_01_11_000000_create_group_capability_table.php renamed to database/migrations/create_group_capability_table.php

@@ -46,6 +46,9 @@ public function handle(): void
         // Policies...
         (new Filesystem)->copyDirectory(__DIR__.'/../../stubs/app/Policies', app_path('Policies'));
 
+        // Controllers...
+        (new Filesystem)->copyDirectory(__DIR__.'/../../stubs/app/Controllers', app_path('Http/Controllers/'));
+
         $this->info('All done. Have a nice journey.');
     }
-}
+}

database/migrations/0001_01_09_000000_create_groups_table.php renamed to database/migrations/create_groups_table.php

@@ -34,8 +34,8 @@ public function __construct(InvitationModel $invitation)
      */
     public function build(): static
     {
-        return $this->markdown('teams::emails.invitation', ['acceptUrl' => URL::signedRoute('invitations.accept', [
+        return $this->markdown('teams::emails.invitation', ['url' => URL::signedRoute('teams.invitations.accept', [
             'invitation' => $this->invitation,
         ])])->subject(__('Team Invitation'));
     }
-}
+}

database/migrations/0001_01_07_000000_create_invitations_table.php renamed to database/migrations/create_invitations_table.php

@@ -7,10 +7,15 @@
 
 class Ability extends Teams
 {
+
     /**
      * Handle incoming request.
      *
-     * @param  array  ...$models
+     * @param Request $request
+     * @param Closure $next
+     * @param string $ability
+     * @param ...$models
+     * @return mixed
      */
     public function handle(Request $request, Closure $next, string $ability, ...$models): mixed
     {
@@ -20,4 +25,4 @@ public function handle(Request $request, Closure $next, string $ability, ...$mod
 
         return $next($request);
     }
-}
+}