Merge pull request #115 from fschmtt/command-array-payload

Allow passing array payload and criteria

Author: fschmtt

phpstan.neon

@@ -1,6 +1,7 @@
 parameters:
   level: 7
-  checkGenericClassInNonGenericObjectType: false
+  ignoreErrors:
+    - identifier: missingType.generics
   paths:
     - src
     - tests

src/Attribute/Since.php

@@ -6,6 +6,9 @@
 
 use Attribute;
 
+/**
+ * @internal
+ */
 #[Attribute]
 class Since
 {

src/Attribute/Until.php

@@ -6,6 +6,9 @@
 
 use Attribute;
 
+/**
+ * @internal
+ */
 #[Attribute]
 class Until
 {

src/Exception/JsonDecodeException.php

@@ -6,6 +6,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 class JsonDecodeException extends Exception
 {
 }

src/Exception/JsonEncodeException.php

@@ -6,6 +6,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 class JsonEncodeException extends Exception
 {
 }

src/Exception/PropertyDoesNotExistException.php

@@ -6,6 +6,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 class PropertyDoesNotExistException extends Exception
 {
 }

src/Exception/ReadOnlyException.php

@@ -6,6 +6,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 class ReadOnlyException extends Exception
 {
 }

src/Exception/SerializerException.php

@@ -6,6 +6,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 class SerializerException extends Exception
 {
 }

src/Exception/TokenStorageException.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Exception;
 
+/**
+ * @internal
+ */
 class TokenStorageException extends \RuntimeException
 {
 }

src/Http/Client.php

@@ -13,6 +13,9 @@
 use Lcobucci\JWT\Token;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal
+ */
 class Client
 {
     public function __construct(

src/Http/Command.php

@@ -7,14 +7,19 @@
 use Fschmtt\Keycloak\Collection\Collection;
 use Fschmtt\Keycloak\Representation\Representation;
 
+/**
+ * @internal
+ */
 class Command
 {
     public function __construct(
         private readonly string $path,
         private readonly Method $method,
         /** @var array<string, string> */
         private readonly array $parameters = [],
-        private readonly Representation|Collection|null $payload = null,
+        /** @var Representation|Collection|array<mixed>|null */
+        private readonly Representation|Collection|array|null $payload = null,
+        private readonly ?Criteria $criteria = null,
     ) {
     }
 
@@ -32,15 +37,29 @@ public function getPath(): string
 
         $values = array_values($this->parameters);
 
-        return str_replace(
+        $path = str_replace(
             $placeholders,
             $values,
             $this->path
         );
+
+        return $path . $this->getQuery();
     }
 
-    public function getPayload(): Representation|Collection|null
+    /**
+     * @return Representation|Collection|array<mixed>|null
+     */
+    public function getPayload(): Representation|Collection|array|null
     {
         return $this->payload;
     }
+
+    public function getQuery(): string
+    {
+        if (!$this->criteria) {
+            return '';
+        }
+
+        return '?' . http_build_query($this->criteria->jsonSerialize());
+    }
 }

src/Http/CommandExecutor.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\Json\JsonEncoder;
 use Fschmtt\Keycloak\Representation\Representation;
 
+/**
+ * @internal
+ */
 class CommandExecutor
 {
     public function __construct(
@@ -31,19 +34,25 @@ public function executeCommand(Command $command): void
 
     protected function prepareBody(Command $command): ?string
     {
-        if ($command->getPayload() === null) {
+        $payload = $command->getPayload();
+
+        if ($payload === null) {
             return null;
         }
 
         $jsonEncoder = new JsonEncoder();
 
-        if ($command->getPayload() instanceof Representation) {
-            return $jsonEncoder->encode($this->propertyFilter->filter($command->getPayload()));
+        if (is_array($payload)) {
+            return $jsonEncoder->encode($payload);
+        }
+
+        if ($payload instanceof Representation) {
+            return $jsonEncoder->encode($this->propertyFilter->filter($payload));
         }
 
         $representations = [];
 
-        foreach ($command->getPayload() as $representation) {
+        foreach ($payload as $representation) {
             $representations[] = $this->propertyFilter->filter($representation);
         }
 

src/Http/Criteria.php

@@ -7,6 +7,9 @@
 use DateTimeInterface;
 use Stringable;
 
+/**
+ * @internal
+ */
 class Criteria
 {
     /**

src/Http/Method.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Http;
 
+/**
+ * @internal
+ */
 enum Method: string
 {
     case GET = 'GET';

src/Http/PropertyFilter.php

@@ -9,6 +9,9 @@
 use Fschmtt\Keycloak\Representation\Representation;
 use ReflectionClass;
 
+/**
+ * @internal
+ */
 class PropertyFilter
 {
     /**

src/Http/Query.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Http;
 
+/**
+ * @internal
+ */
 class Query
 {
     public function __construct(

src/Http/QueryExecutor.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\Json\JsonDecoder;
 use Fschmtt\Keycloak\Serializer\Serializer;
 
+/**
+ * @internal
+ */
 class QueryExecutor
 {
     public function __construct(

src/Json/JsonDecoder.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\Exception\JsonDecodeException;
 use JsonException;
 
+/**
+ * @internal
+ */
 class JsonDecoder
 {
     /**

src/Json/JsonEncoder.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\Exception\JsonEncodeException;
 use JsonException;
 
+/**
+ * @internal
+ */
 class JsonEncoder
 {
     /**

src/OAuth/TokenStorage/Filesystem.php

@@ -9,6 +9,9 @@
 use Lcobucci\JWT\Encoding\JoseEncoder;
 use Lcobucci\JWT\Token;
 
+/**
+ * @internal
+ */
 class Filesystem implements TokenStorageInterface
 {
     private string $accessTokenPath;

src/OAuth/TokenStorage/InMemory.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\OAuth\TokenStorageInterface;
 use Lcobucci\JWT\Token;
 
+/**
+ * @internal
+ */
 class InMemory implements TokenStorageInterface
 {
     private ?Token $accessToken = null;

src/Resource/Users.php

@@ -204,7 +204,10 @@ public function removeRealmRoles(string $realm, string $userId, RoleCollection $
         );
     }
 
-    public function executeActionsEmail(string $realm, string $userId): void
+    /**
+     * @param list<string>|null $actions
+     */
+    public function executeActionsEmail(string $realm, string $userId, ?array $actions = null, ?Criteria $criteria = null): void
     {
         $this->commandExecutor->executeCommand(
             new Command(
@@ -213,7 +216,9 @@ public function executeActionsEmail(string $realm, string $userId): void
                 [
                     'realm' => $realm,
                     'userId' => $userId,
-                ]
+                ],
+                $actions,
+                $criteria,
             )
         );
     }

src/Serializer/ArraySerializer.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Serializer;
 
+/**
+ * @internal
+ */
 class ArraySerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/BooleanSerializer.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Serializer;
 
+/**
+ * @internal
+ */
 class BooleanSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/CollectionSerializer.php

@@ -7,6 +7,9 @@
 use Fschmtt\Keycloak\Collection\Collection;
 use Fschmtt\Keycloak\Representation\Representation;
 
+/**
+ * @internal
+ */
 class CollectionSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/EnumSerializer.php

@@ -7,6 +7,9 @@
 use BackedEnum;
 use Fschmtt\Keycloak\Enum\Enum;
 
+/**
+ * @internal
+ */
 class EnumSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/Factory.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Serializer;
 
+/**
+ * @internal
+ */
 class Factory
 {
     public function create(): Serializer

src/Serializer/IntegerSerializer.php

@@ -4,6 +4,9 @@
 
 namespace Fschmtt\Keycloak\Serializer;
 
+/**
+ * @internal
+ */
 class IntegerSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/MapSerializer.php

@@ -6,6 +6,9 @@
 
 use Fschmtt\Keycloak\Type\Map;
 
+/**
+ * @internal
+ */
 class MapSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/RepresentationSerializer.php

@@ -6,6 +6,9 @@
 
 use Fschmtt\Keycloak\Representation\Representation;
 
+/**
+ * @internal
+ */
 class RepresentationSerializer implements SerializerInterface
 {
     public function serializes(): string

src/Serializer/Serializer.php

@@ -10,6 +10,9 @@
 use Fschmtt\Keycloak\Exception\SerializerException;
 use Fschmtt\Keycloak\Representation\Representation;
 
+/**
+ * @internal
+ */
 class Serializer implements SerializerInterface
 {
     private const NATIVE_TYPES = [