Merge pull request #39 from rupadana/dev

feat: Middleware API on ApiServicePlugin class

.github/workflows/discord-release-notification.yml

@@ -0,0 +1,13 @@
+on:
+  release:
+    types: [released]
+
+jobs:
+  message:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Discord Webhook Action
+      uses: tsickert/[email protected]
+      with:
+        webhook-url: ${{ secrets.WEBHOOK_URL }}
+        content: "# Released Version ${{ github.event.release.name }} \n\n\n${{ github.event.release.body }}"

README.md

@@ -46,6 +46,7 @@ return [
     ],
     'route' => [
         'panel_prefix' => true,
+        'use_resource_middlewares' => false,
     ],
     'tenancy' => [
         'enabled' => false,
@@ -190,6 +191,36 @@ You can edit prefix & group route name as you want, default this plugin use mode
     }
 ```
 
+### Middlewares
+
+You can add or override middlewares at two specific places. Via the Filament Panel Provider and/or via the Resources $routeMiddleware.
+
+If you set `route.use_resource_middlewares` to true, the package will register the middlewares for that specific resource as defined in:
+
+```php
+class BlogResource extends Resource
+    {
+        ...
+        protected static string | array $routeMiddleware = []; // <-- your specific resource middlewares
+        ...
+    }
+```
+
+Then your API resource endpoint will go through these middlewares first.
+
+Another method of adding/overriding middlewares is via the initialization of the plugin in your Panel Provider by adding the `middleware()` method like so:
+
+```php
+use Rupadana\ApiService\ApiServicePlugin;
+
+$panel->plugins([
+    ApiServicePlugin::make()
+        ->middleware([
+        // ... add your middlewares
+        ])
+])
+```
+
 ### Tenancy
 
 When you want to enable Tenancy on this package you can enable this by setting the config `tenancy.enabled` to `true`. This makes sure that your api responses only retreive the data which that user has access to. So if you have configured 5 tenants and an user has access to 2 tenants. Then, enabling this feature will return only the data of those 2 tenants.

config/api-service.php

@@ -21,6 +21,7 @@
     ],
     'route' => [
         'panel_prefix' => true,
+        'use_resource_middlewares' => false,
     ],
     'tenancy' => [
         'enabled' => false,

routes/api.php

@@ -20,6 +20,8 @@
                 $hasTenancy = $panel->hasTenancy();
                 $tenantRoutePrefix = $panel->getTenantRoutePrefix();
                 $tenantSlugAttribute = $panel->getTenantSlugAttribute();
+                $apiServicePlugin = $panel->getPlugin('api-service');
+                $middlewares = $apiServicePlugin->getMiddlewares();
                 $panelRoutePrefix = ApiService::isRoutePrefixedByPanel() ? '{panel}' : '';
                 $panelNamePrefix = $panelRoutePrefix ? $panel->getId() . '.' : '';
 
@@ -30,15 +32,16 @@
                 ) {
                     Route::prefix($panelRoutePrefix . '/' . (($tenantRoutePrefix) ? "{$tenantRoutePrefix}/" : '') . '{tenant' . (($tenantSlugAttribute) ? ":{$tenantSlugAttribute}" : '') . '}')
                         ->name($panelNamePrefix)
-                        ->group(function () use ($panel) {
-                            $apiServicePlugin = $panel->getPlugin('api-service');
+                        ->middleware($middlewares)
+                        ->group(function () use ($panel, $apiServicePlugin) {
                             $apiServicePlugin->route($panel);
                         });
                 }
 
                 if (! ApiService::tenancyAwareness()) {
                     Route::prefix($panelRoutePrefix)
                         ->name($panelNamePrefix)
+                        ->middleware($middlewares)
                         ->group(function () use ($panel) {
                             $apiServicePlugin = $panel->getPlugin('api-service');
                             $apiServicePlugin->route($panel);

src/ApiService.php

@@ -2,6 +2,7 @@
 
 namespace Rupadana\ApiService;
 
+use Filament\Panel;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Facades\Route;
 use Rupadana\ApiService\Concerns\HasTenancy;
@@ -32,7 +33,7 @@ public static function getResource()
         return static::$resource;
     }
 
-    public static function registerRoutes()
+    public static function registerRoutes(Panel $panel)
     {
 
         $slug = static::getResource()::getSlug();
@@ -41,9 +42,10 @@ public static function registerRoutes()
             ->replace('/', '.')
             ->append('.');
 
-        Route::name(
-            $name
-        )
+        $resourceRouteMiddlewares = static::useResourceMiddlewares() ? static::getResource()::getRouteMiddleware($panel) : [];
+
+        Route::name($name)
+            ->middleware($resourceRouteMiddlewares)
             ->prefix(static::$groupRouteName ?? $slug)
             ->group(function (Router $route) {
                 static::handlers();
@@ -63,4 +65,9 @@ public static function isRoutePrefixedByPanel(): bool
     {
         return config('api-service.route.panel_prefix', true);
     }
+
+    public static function useResourceMiddlewares(): bool
+    {
+        return config('api-service.route.use_resource_middlewares', false);
+    }
 }

src/ApiServicePlugin.php

@@ -12,6 +12,11 @@ class ApiServicePlugin implements Plugin
 {
     use CanManipulateFiles;
 
+    /**
+     * @var array<string>
+     */
+    protected array $middleware = [];
+
     public function getId(): string
     {
         return 'api-service';
@@ -65,7 +70,7 @@ public function route(Panel $panel): void
 
                 $apiServiceClass = $resource . '\\Api\\' . $resourceName . 'ApiService';
 
-                app($apiServiceClass)->registerRoutes();
+                app($apiServiceClass)->registerRoutes($panel);
             } catch (Exception $e) {
             }
         }
@@ -83,4 +88,22 @@ public static function get(): static
 
         return $plugin;
     }
+
+    /**
+     * @param array<string> $middleware
+     */
+    public function middleware(array $middleware): static
+    {
+        $this->middleware = [
+            ...$this->middleware,
+            ...$middleware,
+        ];
+
+        return $this;
+    }
+
+    public function getMiddlewares(): array
+    {
+        return $this->middleware;
+    }
 }

src/Http/Handlers.php

@@ -8,13 +8,11 @@
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Routing\Router;
 use Rupadana\ApiService\ApiService;
-use Rupadana\ApiService\Traits\HasHandlerTenantScope;
 use Rupadana\ApiService\Traits\HttpResponse;
 use Rupadana\ApiService\Transformers\DefaultTransformer;
 
 class Handlers
 {
-    use HasHandlerTenantScope;
     use HttpResponse;
     protected Panel $panel;
     public static ?string $uri = '/';

stubs/PaginationHandler.stub

@@ -19,9 +19,10 @@ class PaginationHandler extends Handlers {
         ->allowedFields($model::$allowedFields ?? [])
         ->allowedSorts($model::$allowedSorts ?? [])
         ->allowedFilters($model::$allowedFilters ?? [])
+        ->allowedIncludes($model::$allowedIncludes ?? null)
         ->paginate(request()->query('per_page'))
         ->appends(request()->query());
 
         return static::getApiTransformer()::collection($query);
     }
-}
+}