Merge pull request codeigniter4#1330 from datamweb/fix-phpstan-error

chore(phpstan): use unsealed array shapes for credentials

Author: datamweb

phpstan-baseline.php

@@ -68,13 +68,13 @@
 	'path' => __DIR__ . '/src/Authentication/Authenticators/JWT.php',
 ];
 $ignoreErrors[] = [
-	'rawMessage' => 'Parameter #1 $credentials (array{token?: string}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\JWT::attempt() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::attempt()',
+	'rawMessage' => 'Parameter #1 $credentials (array{token?: string, ...}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\JWT::attempt() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::attempt()',
 	'identifier' => 'method.childParameterType',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Authentication/Authenticators/JWT.php',
 ];
 $ignoreErrors[] = [
-	'rawMessage' => 'Parameter #1 $credentials (array{token?: string}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\JWT::check() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::check()',
+	'rawMessage' => 'Parameter #1 $credentials (array{token?: string, ...}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\JWT::check() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::check()',
 	'identifier' => 'method.childParameterType',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Authentication/Authenticators/JWT.php',
@@ -110,13 +110,13 @@
 	'path' => __DIR__ . '/src/Authentication/Authenticators/Session.php',
 ];
 $ignoreErrors[] = [
-	'rawMessage' => 'Parameter #1 $credentials (array{email?: string, username?: string, password?: string}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\Session::attempt() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::attempt()',
+	'rawMessage' => 'Parameter #1 $credentials (array{email?: string, username?: string, password?: string, ...}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\Session::attempt() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::attempt()',
 	'identifier' => 'method.childParameterType',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Authentication/Authenticators/Session.php',
 ];
 $ignoreErrors[] = [
-	'rawMessage' => 'Parameter #1 $credentials (array{email?: string, username?: string, password?: string}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\Session::check() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::check()',
+	'rawMessage' => 'Parameter #1 $credentials (array{email?: string, username?: string, password?: string, ...}) of method CodeIgniter\\Shield\\Authentication\\Authenticators\\Session::check() should be contravariant with parameter $credentials (array) of method CodeIgniter\\Shield\\Authentication\\AuthenticatorInterface::check()',
 	'identifier' => 'method.childParameterType',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Authentication/Authenticators/Session.php',

src/Auth.php

@@ -25,17 +25,17 @@
 /**
  * Facade for Authentication
  *
- * @method Result    attempt(array{email?: string, username?: string, password?: string, token?: string} $credentials)
- * @method Result    check(array{email?: string, username?: string, password?: string, token?: string} $credentials)
- * @method bool      checkAction(string $token, string $type)                                                          [Session]
- * @method void      forget(?User $user = null)                                                                        [Session]
+ * @method Result    attempt(array{email?: string, username?: string, password?: string, token?: string, ...} $credentials)
+ * @method Result    check(array{email?: string, username?: string, password?: string, token?: string, ...} $credentials)
+ * @method bool      checkAction(string $token, string $type)                                                               [Session]
+ * @method void      forget(?User $user = null)                                                                             [Session]
  * @method User|null getUser()
  * @method bool      loggedIn()
  * @method bool      login(User $user)
  * @method void      loginById($userId)
  * @method bool      logout()
  * @method void      recordActiveDate()
- * @method $this     remember(bool $shouldRemember = true)                                                             [Session]
+ * @method $this     remember(bool $shouldRemember = true)                                                                  [Session]
  */
 class Auth
 {

src/Authentication/Authenticators/JWT.php

@@ -64,7 +64,7 @@ public function __construct(
      * Attempts to authenticate a user with the given $credentials.
      * Logs the user in with a successful check.
      *
-     * @param array{token?: string} $credentials
+     * @param array{token?: string, ...} $credentials
      */
     public function attempt(array $credentials): Result
     {
@@ -141,7 +141,7 @@ public function attempt(array $credentials): Result
      * In this case, $credentials has only a single valid value: token,
      * which is the plain text token to return.
      *
-     * @param array{token?: string} $credentials
+     * @param array{token?: string, ...} $credentials
      */
     public function check(array $credentials): Result
     {

src/Authentication/Authenticators/Session.php

@@ -122,7 +122,7 @@ public function remember(bool $shouldRemember = true): self
      * Attempts to authenticate a user with the given $credentials.
      * Logs the user in with a successful check.
      *
-     * @phpstan-param array{email?: string, username?: string, password?: string} $credentials
+     * @phpstan-param array{email?: string, username?: string, password?: string, ...} $credentials
      */
     public function attempt(array $credentials): Result
     {
@@ -315,7 +315,7 @@ private function recordLoginAttempt(
      * Checks a user's $credentials to see if they match an
      * existing user.
      *
-     * @phpstan-param array{email?: string, username?: string, password?: string} $credentials
+     * @phpstan-param array{email?: string, username?: string, password?: string, ...} $credentials
      */
     public function check(array $credentials): Result
     {