Fix lint issues in Config.

composer.json

@@ -10,7 +10,10 @@
     ],
     "type": "library",
     "require": {
-        "php": ">=7.4 <=8.4.1"
+        "php": ">=7.4 <=8.4.1",
+        "ext-json": "*",
+        "ext-openssl": "*",
+        "ext-curl": "*"
     },
     "license": "MIT",
     "autoload": {
@@ -39,7 +42,8 @@
         "phpunit/phpunit": "^9.6",
         "slevomat/coding-standard": "^8.4",
         "squizlabs/php_codesniffer": "^3.11",
-        "vimeo/psalm": "^4.9"
+        "vimeo/psalm": "^4.9",
+        "friendsofphp/php-cs-fixer": "^3.65"
     },
     "scripts": {
         "analyze": [

src/Config/ConfigInterface.php

@@ -6,10 +6,15 @@ interface ConfigInterface
 {
     public function getProduction(): bool;
     public function getSameSiteStrict(): ?bool;
+    /**  @return array<string, int|string>|null */
     public function getError(): ?array;
+    /**  @return array<string, string>|null */
     public function getScope(): ?array;
+    /**  @return array<string>|null */
     public function getProviderHint(): ?array;
+    /**  @return array<string, string> */
     public function getRoutes(): array;
+    /**  @return array<string, string> */
     public function getCookies(): array;
     public function getLoginSync(): ?callable;
     public function getLogoutSync(): ?callable;

src/Config/Constants.php

@@ -7,22 +7,30 @@ class Constants
     public static string $PRODUCTION_WALLET = 'https://wallet.hello.coop';
     public static string $DEFAULT_PATH = '/authorize';
     public static string $HELLO_API_ROUTE =  '/api/hellocoop';
+    /** @var array<string> */
     public static array $DEFAULT_SCOPE = ['openid', 'name', 'email', 'picture'];
     public static string $DEFAULT_RESPONSE_TYPE = 'code';
     public static string $DEFAULT_RESPONSE_MODE = 'query';
 
+    /** @var array<string> */
     public static array $VALID_IDENTITY_STRING_CLAIMS = [
         'name', 'nickname', 'preferred_username', 'given_name', 'family_name',
         'email', 'phone', 'picture', 'ethereum',
     ];
 
+    /**
+     * @var array<string>
+     */
     public static array $VALID_IDENTITY_ACCOUNT_CLAIMS = [
         'discord', 'twitter', 'github', 'gitlab'
     ];
 
     public static string $ORG_CLAIM = 'org';
 
-    public static function getValidIdentityClaims()
+    /**
+     * @return array<string>
+     */
+    public static function getValidIdentityClaims(): array
     {
         return array_merge(
             self::$VALID_IDENTITY_STRING_CLAIMS,
@@ -31,7 +39,10 @@ public static function getValidIdentityClaims()
         );
     }
 
-    public static function getValidScopes()
+    /**
+     * @return array<string>
+     */
+    public static function getValidScopes(): array
     {
         return array_merge(
             self::$VALID_IDENTITY_STRING_CLAIMS,
@@ -40,9 +51,11 @@ public static function getValidScopes()
         );
     }
 
+    /** @var array<string> */
     public static array $VALID_RESPONSE_TYPE = ['id_token', 'code'];
+    /** @var array<string> */
     public static array $VALID_RESPONSE_MODE = ['fragment', 'query', 'form_post'];
-
+    /** @var array<string> */
     public static array $VALID_PROVIDER_HINT = [
         'apple', 'discord', 'facebook', 'github', 'gitlab', 'google',
         'twitch', 'twitter', 'tumblr', 'mastodon', 'microsoft', 'line',

src/Config/HelloConfig.php

@@ -17,15 +17,45 @@ class HelloConfig implements ConfigInterface
     private string $host;
     private ?string $secret = null;
     private ?bool $logDebug = null;
+    /** @var array<string, int|string>|null */
     private ?array $error = null;
+    /** @var array<string> */
     private array $scope;
+    /** @var array<string> */
     private array $providerHint;
+    /** @var array<string, string> */
     private array $routes;
+    /** @var array<string, string> */
     private array $cookies;
+    /** @var callable|null */
     private $loginSync;
+    /** @var callable|null */
     private $logoutSync;
     private bool $production;
 
+    /**
+     * @param string $apiRoute
+     * @param string $authApiRoute
+     * @param string $loginApiRoute
+     * @param string $logoutApiRoute
+     * @param bool $sameSiteStrict
+     * @param string|null $clientId
+     * @param string|null $redirectURI
+     * @param string $host
+     * @param string|null $secret
+     * @param callable|null $loginSync
+     * @param callable|null $logoutSync
+     * @param array<string, string> $cookies
+     * @param bool $production
+     * @param string $helloDomain
+     * @param string|null $helloWallet
+     * @param array<string> $scope
+     * @param array<string> $providerHint
+     * @param array<string, string> $routes
+     * @param bool|null $cookieToken
+     * @param bool|null $logDebug
+     * @param array<string, int|string>|null $error
+     */
     public function __construct(
         string $apiRoute,
         string $authApiRoute,
@@ -89,26 +119,41 @@ public function getSameSiteStrict(): ?bool
         return $this->sameSiteStrict;
     }
 
+    /**
+     * @return array<string, int|string>|null
+     */
     public function getError(): ?array
     {
         return $this->error;
     }
 
+    /**
+     * @return array<string>|null
+     */
     public function getScope(): ?array
     {
         return $this->scope;
     }
 
+    /**
+     * @return array<string>|null
+     */
     public function getProviderHint(): ?array
     {
         return $this->providerHint;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getRoutes(): array
     {
         return $this->routes;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getCookies(): array
     {
         return $this->cookies;

src/Config/HelloConfigBuilder.php

@@ -13,24 +13,31 @@ class HelloConfigBuilder
     private ?string $redirectURI = null;
     private string $host = '';
     private ?string $secret = null;
+    /**  @var array<string, string> */
     private array $cookies = [
         'authName' => 'hellocoop_auth',
         'oidcName' => 'hellocoop_oidc',
     ];
     private bool $production = true;
     private string $helloDomain = 'hello.coop';
     private ?string $helloWallet = null;
+    /**  @var array<string> */
     private array $scope = ['openid', 'name', 'email', 'picture'];
+    /**  @var array<string> */
     private array $providerHint = ['github'];
+    /**  @var array<string, string> */
     private array $routes = [
         'loggedIn' => '/',
         'loggedOut' => '/',
         'error' => '/error',
     ];
+    /**  @var callable|null */
     private $loginSync = null;
+    /**  @var callable|null */
     private $logoutSync = null;
     private ?bool $cookieToken = null;
     private ?bool $logDebug = null;
+    /**  @var array<string, int|string>|null */
     private ?array $error = null;
 
     public function setApiRoute(string $apiRoute): self
@@ -87,6 +94,9 @@ public function setSecret(?string $secret): self
         return $this;
     }
 
+    /**
+     * @param array<string, string> $cookies
+     */
     public function setCookies(array $cookies): self
     {
         $this->cookies = $cookies;
@@ -111,30 +121,47 @@ public function setHelloWallet(?string $helloWallet): self
         return $this;
     }
 
+    /**
+     * @param array<string> $scope
+     */
     public function setScope(array $scope): self
     {
         $this->scope = $scope;
         return $this;
     }
 
+    /**
+     * @param array<string> $providerHint
+     */
     public function setProviderHint(array $providerHint): self
     {
         $this->providerHint = $providerHint;
         return $this;
     }
 
+    /**
+     * @param array<string, string> $routes
+     */
     public function setRoutes(array $routes): self
     {
         $this->routes = $routes;
         return $this;
     }
 
+    /**
+     * @param callable|null $loginSync
+     * @return HelloConfigBuilder
+     */
     public function setLoginSync(?callable $loginSync): self
     {
         $this->loginSync = $loginSync;
         return $this;
     }
 
+    /**
+     * @param callable|null $logoutSync
+     * @return HelloConfigBuilder
+     */
     public function setLogoutSync(?callable $logoutSync): self
     {
         $this->logoutSync = $logoutSync;
@@ -153,6 +180,9 @@ public function setLogDebug(?bool $logDebug): self
         return $this;
     }
 
+    /**
+     * @param array<string, int|string>|null $error
+     */
     public function setError(?array $error): self
     {
         $this->error = $error;

src/Exception/CallbackException.php

@@ -7,8 +7,15 @@
 
 class CallbackException extends Exception
 {
+    /** @var array<string, int|string> */
     private array $errorDetails;
 
+    /**
+     * @param array<string, int|string> $errorDetails
+     * @param string $message
+     * @param int $code
+     * @param Throwable|null $previous
+     */
     public function __construct(
         array $errorDetails,
         $message = "Callback Exception",
@@ -19,6 +26,9 @@ public function __construct(
         parent::__construct($message, $code, $previous);
     }
 
+    /**
+     * @return array<string, int|string>
+     */
     public function getErrorDetails(): array
     {
         return $this->errorDetails;

src/Exception/CryptoFailedException.php

@@ -6,5 +6,6 @@
 
 class CryptoFailedException extends Exception
 {
+    /** @var string  */
     protected $message = 'Crypto failed. There was an error encrypting the data.';
 }

src/Exception/DecryptionFailedException.php

@@ -6,5 +6,6 @@
 
 class DecryptionFailedException extends Exception
 {
+    /** @var string  */
     protected $message = 'Decryption failed. The data may be corrupted or the wrong key was used.';
 }

src/Exception/InvalidSecretException.php

@@ -6,5 +6,6 @@
 
 class InvalidSecretException extends Exception
 {
+    /** @var string  */
     protected $message = 'Invalid secret key. Must be a 64-character hexadecimal string.';
 }

src/Exception/NotImplementedException.php

@@ -6,4 +6,6 @@
 
 class NotImplementedException extends BadMethodCallException
 {
+    /** @var string  */
+    protected $message = 'Not Implemented.';
 }

src/Exception/SameSiteCallbackException.php

@@ -7,8 +7,11 @@
 
 class SameSiteCallbackException extends Exception
 {
-    private array $errorDetails;
-
+    /**
+     * @param string $message
+     * @param int $code
+     * @param Throwable|null $previous
+     */
     public function __construct(
         $message = "Same Site Callback Exception",
         $code = 0,

src/Handler/Auth.php

@@ -15,6 +15,7 @@ class Auth
     private HelloRequestInterface $helloRequest;
     private ConfigInterface $config;
     private ?AuthLib $authLib = null;
+
     public function __construct(
         HelloRequestInterface $helloRequest,
         HelloResponseInterface $helloResponse,
@@ -38,6 +39,7 @@ public function handleAuth(): ?AuthType
     {
         return $this->getAuthLib()->getAuthfromCookies();
     }
+
     public function updateAuth(AuthUpdates $authUpdates): ?AuthType
     {
         $auth = $this->getAuthLib()->getAuthfromCookies();
@@ -48,6 +50,7 @@ public function updateAuth(AuthUpdates $authUpdates): ?AuthType
         $updatedAuth = array_merge($auth->toArray(), $authUpdates->toArray());
         return AuthType::fromArray($updatedAuth);
     }
+
     public function clearAuth(): void
     {
         $this->getAuthLib()->clearAuthCookie();