Update Group Edit API

app/assets/composable/useGroupEditApi.ts

@@ -0,0 +1,63 @@
+import { ref } from 'vue'
+import axios from 'axios'
+import { Severity, type AlertInterface } from '@userfrosting/sprinkle-core/types'
+
+/**
+ * Interfaces - What the API expects and what it returns
+ */
+interface GroupEditForm {
+    slug: string
+    name: string
+    description: string
+    icon: string
+}
+
+interface GroupEditResponse {
+    success: boolean
+    message: string
+    group: GroupEditForm
+}
+
+// TODO : Add validation
+// 'schema://requests/group/edit-info.yaml'
+
+/**
+ * API Composable
+ */
+export function useGroupEditApi() {
+    const loadingState = ref<Boolean>(false)
+    const apiError = ref<AlertInterface | null>(null)
+
+    async function submitGroupEdit(slug: string, data: GroupEditForm) {
+        loadingState.value = true
+        apiError.value = null
+        return axios
+            .put<GroupEditResponse>('/api/groups/g/' + slug, data)
+            .then((response) => {
+                return {
+                    success: response.data.success,
+                    message: response.data.message,
+                    group: response.data.group
+                }
+            })
+            .catch((err) => {
+                apiError.value = {
+                    ...{
+                        description: 'An error as occurred',
+                        style: Severity.Danger,
+                        closeBtn: true
+                    },
+                    ...err.response.data
+                }
+
+                throw apiError.value
+            })
+            .finally(() => {
+                loadingState.value = false
+            })
+    }
+
+    return { submitGroupEdit, loadingState, apiError }
+}
+
+export type { GroupEditForm, GroupEditResponse }

app/src/Controller/Group/GroupEditAction.php

@@ -15,12 +15,12 @@
 use Illuminate\Database\Connection;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
-use UserFrosting\Alert\AlertStream;
 use UserFrosting\Config\Config;
 use UserFrosting\Fortress\RequestSchema;
 use UserFrosting\Fortress\RequestSchema\RequestSchemaInterface;
 use UserFrosting\Fortress\Transformer\RequestDataTransformer;
 use UserFrosting\Fortress\Validator\ServerSideValidator;
+use UserFrosting\I18n\Translator;
 use UserFrosting\Sprinkle\Account\Authenticate\Authenticator;
 use UserFrosting\Sprinkle\Account\Database\Models\Interfaces\GroupInterface;
 use UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface;
@@ -50,7 +50,7 @@ class GroupEditAction
      * Inject dependencies.
      */
     public function __construct(
-        protected AlertStream $alert,
+        protected Translator $translator,
         protected Authenticator $authenticator,
         protected Config $config,
         protected Connection $db,
@@ -71,8 +71,12 @@ public function __construct(
      */
     public function __invoke(GroupInterface $group, Request $request, Response $response): Response
     {
-        $this->handle($group, $request);
-        $payload = json_encode([], JSON_THROW_ON_ERROR);
+        $group = $this->handle($group, $request);
+        $payload = json_encode([
+            'success' => true,
+            'message' => $this->translator->translate('GROUP.UPDATE', $group->toArray()),
+            'group'   => $group,
+        ], JSON_THROW_ON_ERROR);
         $response->getBody()->write($payload);
 
         return $response->withHeader('Content-Type', 'application/json');
@@ -83,8 +87,10 @@ public function __invoke(GroupInterface $group, Request $request, Response $resp
      *
      * @param GroupInterface $group
      * @param Request        $request
+     *
+     * @return GroupInterface
      */
-    protected function handle(GroupInterface $group, Request $request): void
+    protected function handle(GroupInterface $group, Request $request): GroupInterface
     {
         // Get PUT parameters
         $params = (array) $request->getParsedBody();
@@ -138,9 +144,7 @@ protected function handle(GroupInterface $group, Request $request): void
             ]);
         });
 
-        $this->alert->addMessage('success', 'GROUP.UPDATE', [
-            'name' => $group->name,
-        ]);
+        return $group;
     }
 
     /**

app/tests/Controller/Group/GroupEditActionTest.php

@@ -13,7 +13,6 @@
 namespace UserFrosting\Sprinkle\Admin\Tests\Controller\Group;
 
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
-use UserFrosting\Alert\AlertStream;
 use UserFrosting\Sprinkle\Account\Database\Models\Group;
 use UserFrosting\Sprinkle\Account\Database\Models\User;
 use UserFrosting\Sprinkle\Account\Testing\WithTestUser;
@@ -116,7 +115,14 @@ public function testPage(): void
 
         // Assert response status & body
         $this->assertResponseStatus(200, $response);
-        $this->assertJsonResponse([], $response);
+        $this->assertJsonStructure([
+            'success',
+            'message',
+            'group',
+        ], $response);
+        $this->assertJsonResponse(true, $response, 'success');
+        $this->assertJsonResponse('Details updated for group <strong>The Foo</strong>', $response, 'message');
+        $this->assertJsonResponse('The Foo', $response, 'group.name');
 
         // Test that the user was updated
         /** @var Group */
@@ -125,12 +131,6 @@ public function testPage(): void
         $this->assertSame('The Foo', $editedGroup['name']);
         $this->assertSame('fas fas-icon', $editedGroup['icon']);
         $this->assertSame('Foo description', $editedGroup['description']);
-
-        // Test message
-        /** @var AlertStream */
-        $ms = $this->ci->get(AlertStream::class);
-        $messages = $ms->getAndClearMessages();
-        $this->assertSame('success', array_reverse($messages)[0]['type']);
     }
 
     /**
@@ -158,7 +158,12 @@ public function testPageWithSameData(): void
 
         // Assert response status & body
         $this->assertResponseStatus(200, $response);
-        $this->assertJsonResponse([], $response);
+        $this->assertJsonStructure([
+            'success',
+            'message',
+            'group',
+        ], $response);
+        $this->assertJsonResponse($group->name, $response, 'group.name');
     }
 
     public function testPostForFailedValidation(): void