Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ferdiunal/nova-shield
Nova Shield simplifies permission management for your Laravel Nova resources using Spatie Permission. Easily grant or revoke access to specific resources and actions, streamlining your workflow and improving security.
https://github.com/ferdiunal/nova-shield
laravel laravel-nova laravel-nova-tool laravel-permission nova nova-extension spatie-laravel-permission
Last synced: about 12 hours ago
JSON representation
Nova Shield simplifies permission management for your Laravel Nova resources using Spatie Permission. Easily grant or revoke access to specific resources and actions, streamlining your workflow and improving security.
- Host: GitHub
- URL: https://github.com/ferdiunal/nova-shield
- Owner: ferdiunal
- License: mit
- Created: 2024-09-02T09:39:52.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T10:19:34.000Z (about 1 month ago)
- Last Synced: 2024-10-07T10:44:35.054Z (about 1 month ago)
- Topics: laravel, laravel-nova, laravel-nova-tool, laravel-permission, nova, nova-extension, spatie-laravel-permission
- Language: PHP
- Homepage: https://ferdiunal.tech
- Size: 1.61 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nova Shield - WIP
**Nova Shield** simplifies permission management for your [Laravel Nova](https://nova.laravel.com) resources using [Spatie Permission](https://github.com/spatie/laravel-permission). Easily grant or revoke access to specific resources and actions, streamlining your workflow and improving security.
## Installation
```bash
composer require ferdiunal/nova-shield
```
## Configuration
Optionally, you can publish the configuration file using this command:
```bash
php artisan vendor:publish --tag nova-shield-config
```
In the config file, you can control resource permissions by specifying the resources parameter with either the path to the Nova resources folder or a string class path.
For example, in the code below, we define the resources and their corresponding policies:
Show Code
```php
[
app_path('Nova'),
\Ferdiunal\NovaShield\Http\Nova\ShieldResource::class,
// Custom resource: For custom menu items
// [
// "name" => "Custom Menu Item",
// "prefix" => "customMenuItem::",
// "policies" => ["CustomMenuPolicy"] // Add custom menu policies here
// ]
],
// 'teamFields' => \App\Lib\TeamField::class,
/**
* Constant policies of Laravel Nova
*/
'policies' => [
'viewAny',
'view',
'create',
'update',
'replicate',
'delete',
'restore',
'forceDelete',
'runAction',
'runDestructiveAction',
'canImpersonate',
'canBeImpersonated',
'add{Model}',
'attach{Model}',
'attachAny{Model}',
'detach{Model}',
],
/**
* Specify the file path of each language files for authorisations.
*/
'langs' => [
// lang_path('en/nova-shield.json'),
// base_path('langs/en/nova-shield.json'),
],
/**
* Default Super admin role name and guard
*/
'superAdmin' => [
'name' => 'super-admin',
'guard' => 'web',
],
'hooks' => [
/**
* When matching permissions with roles, upsert is used by default.
* If you are using custom ID types like UUID or ULID, you need to include them in the upsert operation.
* Therefore, you can write and use a query that suits your project needs.
*/
'permission' => \Ferdiunal\NovaShield\Lib\DefaultPermissionHook::class,
],
];
```
### Custom Menu Configuration
The main purpose of the package was to manage permissions for Nova Resources, but I realized there was a need for Custom Menu support as well. The necessary development has been completed. You can refer to the usage below for implementing Custom Menus.
```php
// app/Providers/NovaServiceProvider.php
Nova::mainMenu(function (Request $request) {
return [
MenuItem::make('Custom Menu Item')
->path('/custom-menu')
->canSee(
function ($request) {
return $request->user()->can('CustomMenuPolicy');
}
)
];
});
// ----
// config/nova-shield.php
return [
"resources" => [
...
// Custom resource: For custom menu items
[
"name" => "Custom Menu Item",
"prefix" => "customMenuItem::",
"policies" => ['CustomMenuPolicy'] // Add custom menu policies here
]
]
];
```
Then edit **`App\Nova\Resource.php`** file as follows.
```php
team_id
}
}
```
### Add Team Field
Considering that the Teams feature will differ in each project, you need to add the team field yourself.
```php
namespace App\Lib;
use Ferdiunal\NovaShield\Lib\NovaTeamHelperField;
use Laravel\Nova\Fields\Field;
use Laravel\Nova\Fields\Select;
class TeamField extends NovaTeamHelperField
{
public static function field(): Field
{
return Select::make('Teams', 'team_id')
->options([])
->displayUsingLabels()
->searchable()
->sortable();
}
}
```
### Add Middleware to Nova Routes
Add TeamMiddleware to nova routes
```php
return [
/*
|--------------------------------------------------------------------------
| Nova Route Middleware
|--------------------------------------------------------------------------
|
| These middleware will be assigned to every Nova route, giving you the
| chance to add your own middleware to this stack or override any of
| the existing middleware. Or, you can just stick with this stack.
|
*/
'middleware' => [
....
\Ferdiunal\NovaShield\Http\Middleware\TeamMiddleware::class,
],
];
```
## Commands
The package contains two different commands. The first command checks whether the Super Admin role exists, creates it if it doesn’t, and assigns permissions to the resources specified in the configuration file. The second command is used to assign the Super Admin role to users.
Sync Super Admin role and permissions command:
```bash
php artisan artisan nova-shield:sync-super-admin
```
Assign Super Admin role to user(s) command:
```bash
php artisan nova-shield:super-admin
```
### Hook Sync Permissions
When mapping permissions to roles, upsert is used by default. If you use custom ID types such as UUID or ULID, upsert does not identify these ids. Therefore, you can write and use a query that suits your project needs.
**Example hook**:
```php
// app/SyncPermissionHook.php
$permissions
* @return void
*/
public function __invoke(Role $role, $permissions)
{
Permission::query()->upsert(
LazyCollection::make($permissions)
->map(function ($permission) use (&$role) {
return [
'id' => Str::uuid(),
'name' => $permission,
'guard_name' => $role->guard_name,
'created_at' => now(),
'updated_at' => now(),
];
})->toArray(),
['name', 'guard_name'],
['name', 'guard_name'],
);
$role->syncPermissions($permissions);
}
}
```
You will then need to replace the class you created in the configuration file with the default.
**Example**:
```php
// config/nova-shield.php
return [
'hooks' => [
/**
* When matching permissions with roles, upsert is used by default.
* If you are using custom ID types like UUID or ULID, you need to include them in the upsert operation.
* Therefore, you can write and use a query that suits your project needs.
*/
'permission' => \App\SyncPermissionHook::class,
],
];
```
## ScreenShots
License This package is open-sourced software licensed under the [MIT license](LICENSE).