fixes

Author: rez1dent3

phpstan.src.baseline.neon

@@ -20,21 +20,6 @@ parameters:
 			count: 1
 			path: src/External/Dto/Option.php
 
-		-
-			message: "#^PHPDoc tag @param references unknown parameter\\: \\$force$#"
-			count: 1
-			path: src/Interfaces/Customer.php
-
-		-
-			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Assembler\\\\OptionDtoAssembler\\:\\:create\\(\\) has parameter \\$data with no value type specified in iterable type array\\.$#"
-			count: 1
-			path: src/Internal/Assembler/OptionDtoAssembler.php
-
-		-
-			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Assembler\\\\OptionDtoAssemblerInterface\\:\\:create\\(\\) has parameter \\$data with no value type specified in iterable type array\\.$#"
-			count: 1
-			path: src/Internal/Assembler/OptionDtoAssemblerInterface.php
-
 		-
 			message: "#^Parameter \\#3 \\$payableId of class Bavix\\\\Wallet\\\\Internal\\\\Dto\\\\TransactionDto constructor expects int\\|string, mixed given\\.$#"
 			count: 1
@@ -56,12 +41,17 @@ parameters:
 			path: src/Internal/Assembler/TransferDtoAssemblerInterface.php
 
 		-
-			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Decorator\\\\StorageServiceLockDecorator\\:\\:get\\(\\) should return string but returns string\\|false\\.$#"
+			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Decorator\\\\StorageServiceLockDecorator\\:\\:multiGet\\(\\) should return non\\-empty\\-array\\<non\\-empty\\-string, non\\-empty\\-string\\> but returns non\\-empty\\-array\\<non\\-empty\\-string, string\\>\\.$#"
+			count: 1
+			path: src/Internal/Decorator/StorageServiceLockDecorator.php
+
+		-
+			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Decorator\\\\StorageServiceLockDecorator\\:\\:multiIncrease\\(\\) should return non\\-empty\\-array\\<non\\-empty\\-string, non\\-empty\\-string\\> but returns non\\-empty\\-array\\<string, string\\>\\.$#"
 			count: 1
 			path: src/Internal/Decorator/StorageServiceLockDecorator.php
 
 		-
-			message: "#^Parameter \\#1 \\$inputs of method Bavix\\\\Wallet\\\\Internal\\\\Decorator\\\\StorageServiceLockDecorator\\:\\:multiSync\\(\\) expects non\\-empty\\-array\\<string, float\\|int\\|string\\>, array\\<string, string\\> given\\.$#"
+			message: "#^Parameter \\#1 \\$inputs of method Bavix\\\\Wallet\\\\Internal\\\\Decorator\\\\StorageServiceLockDecorator\\:\\:multiSync\\(\\) expects non\\-empty\\-array\\<non\\-empty\\-string, float\\|int\\|non\\-empty\\-string\\>, non\\-empty\\-array\\<non\\-empty\\-string, string\\> given\\.$#"
 			count: 1
 			path: src/Internal/Decorator/StorageServiceLockDecorator.php
 
@@ -80,6 +70,16 @@ parameters:
 			count: 1
 			path: src/Internal/Service/StateService.php
 
+		-
+			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageService\\:\\:get\\(\\) should return non\\-empty\\-string but returns string\\.$#"
+			count: 1
+			path: src/Internal/Service/StorageService.php
+
+		-
+			message: "#^Method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageService\\:\\:increase\\(\\) should return non\\-empty\\-string but returns string\\.$#"
+			count: 1
+			path: src/Internal/Service/StorageService.php
+
 		-
 			message: "#^Method Bavix\\\\Wallet\\\\Models\\\\Transaction\\:\\:wallet\\(\\) should return Illuminate\\\\Database\\\\Eloquent\\\\Relations\\\\BelongsTo\\<Bavix\\\\Wallet\\\\Models\\\\Wallet, Bavix\\\\Wallet\\\\Models\\\\Transaction\\> but returns Illuminate\\\\Database\\\\Eloquent\\\\Relations\\\\BelongsTo\\<TRelatedModel of Illuminate\\\\Database\\\\Eloquent\\\\Model, \\$this\\(Bavix\\\\Wallet\\\\Models\\\\Transaction\\)\\>\\.$#"
 			count: 1
@@ -145,16 +145,6 @@ parameters:
 			count: 1
 			path: src/Models/Wallet.php
 
-		-
-			message: "#^Method Bavix\\\\Wallet\\\\Models\\\\Wallet\\:\\:deposit\\(\\) has parameter \\$meta with no value type specified in iterable type array\\.$#"
-			count: 2
-			path: src/Models/Wallet.php
-
-		-
-			message: "#^Method Bavix\\\\Wallet\\\\Models\\\\Wallet\\:\\:forceWithdraw\\(\\) has parameter \\$meta with no value type specified in iterable type array\\.$#"
-			count: 2
-			path: src/Models/Wallet.php
-
 		-
 			message: "#^Method Bavix\\\\Wallet\\\\Models\\\\Wallet\\:\\:getBalanceFloatAttribute\\(\\) should return non\\-empty\\-string but returns string\\.$#"
 			count: 1
@@ -181,7 +171,7 @@ parameters:
 			path: src/Models/Wallet.php
 
 		-
-			message: "#^Method Bavix\\\\Wallet\\\\Models\\\\Wallet\\:\\:withdraw\\(\\) has parameter \\$meta with no value type specified in iterable type array\\.$#"
+			message: "#^Parameter \\#1 \\$amount of method Bavix\\\\Wallet\\\\Interfaces\\\\Wallet\\:\\:forceWithdraw\\(\\) expects int\\|non\\-empty\\-string, int\\|string given\\.$#"
 			count: 2
 			path: src/Models/Wallet.php
 
@@ -205,6 +195,11 @@ parameters:
 			count: 2
 			path: src/Models/Wallet.php
 
+		-
+			message: "#^Parameter \\#2 \\$amount of method Bavix\\\\Wallet\\\\Interfaces\\\\Wallet\\:\\:forceTransfer\\(\\) expects int\\|non\\-empty\\-string, int\\|string given\\.$#"
+			count: 2
+			path: src/Models/Wallet.php
+
 		-
 			message: "#^Parameter \\#2 \\$value of method Bavix\\\\Wallet\\\\Services\\\\RegulatorService\\:\\:increase\\(\\) expects float\\|int\\|non\\-empty\\-string, string given\\.$#"
 			count: 1
@@ -251,7 +246,22 @@ parameters:
 			path: src/Services/AtmService.php
 
 		-
-			message: "#^Method Bavix\\\\Wallet\\\\Services\\\\BookkeeperService\\:\\:multiAmount\\(\\) should return non\\-empty\\-array\\<string, string\\> but returns array\\<string, string\\>\\.$#"
+			message: "#^Parameter \\#1 \\$inputs of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:multiIncrease\\(\\) expects non\\-empty\\-array\\<non\\-empty\\-string, float\\|int\\|non\\-empty\\-string\\>, T of non\\-empty\\-array\\<string, float\\|int\\|string\\> given\\.$#"
+			count: 2
+			path: src/Services/BookkeeperService.php
+
+		-
+			message: "#^Parameter \\#1 \\$inputs of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:multiSync\\(\\) expects non\\-empty\\-array\\<non\\-empty\\-string, float\\|int\\|non\\-empty\\-string\\>, non\\-empty\\-array\\<string, float\\|int\\|string\\> given\\.$#"
+			count: 1
+			path: src/Services/BookkeeperService.php
+
+		-
+			message: "#^Parameter \\#1 \\$uuid of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:forget\\(\\) expects non\\-empty\\-string, string given\\.$#"
+			count: 1
+			path: src/Services/BookkeeperService.php
+
+		-
+			message: "#^Parameter \\#1 \\$uuids of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:multiGet\\(\\) expects non\\-empty\\-array\\<non\\-empty\\-string\\>, non\\-empty\\-array\\<int, string\\> given\\.$#"
 			count: 2
 			path: src/Services/BookkeeperService.php
 
@@ -265,6 +275,31 @@ parameters:
 			count: 1
 			path: src/Services/RegulatorService.php
 
+		-
+			message: "#^Parameter \\#1 \\$uuid of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:forget\\(\\) expects non\\-empty\\-string, string given\\.$#"
+			count: 1
+			path: src/Services/RegulatorService.php
+
+		-
+			message: "#^Parameter \\#1 \\$uuid of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:get\\(\\) expects non\\-empty\\-string, string given\\.$#"
+			count: 1
+			path: src/Services/RegulatorService.php
+
+		-
+			message: "#^Parameter \\#1 \\$uuid of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:increase\\(\\) expects non\\-empty\\-string, string given\\.$#"
+			count: 1
+			path: src/Services/RegulatorService.php
+
+		-
+			message: "#^Parameter \\#1 \\$uuid of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:sync\\(\\) expects non\\-empty\\-string, string given\\.$#"
+			count: 2
+			path: src/Services/RegulatorService.php
+
+		-
+			message: "#^Parameter \\#2 \\$value of method Bavix\\\\Wallet\\\\Internal\\\\Service\\\\StorageServiceInterface\\:\\:sync\\(\\) expects float\\|int\\|non\\-empty\\-string, string given\\.$#"
+			count: 2
+			path: src/Services/RegulatorService.php
+
 		-
 			message: "#^Parameter \\#2 \\$value of method Bavix\\\\Wallet\\\\Services\\\\RegulatorService\\:\\:increase\\(\\) expects float\\|int\\|non\\-empty\\-string, string given\\.$#"
 			count: 1

src/Interfaces/Customer.php

@@ -19,24 +19,22 @@ interface Customer extends Wallet
     /**
      * Purchase a product without payment.
      *
-     * This method purchases the provided product without payment. If the purchase is successful,
-     * the method returns the transfer object. If the purchase fails due to insufficient funds or
-     * empty balance, it returns null. If the purchase fails due to a reason
-     * other than the above, it throws a more specific exception.
+     * This method allows the user to purchase the provided product without any payment involved.
+     * If the purchase is successful, the method returns the transfer object representing the purchase.
      *
      * @param ProductInterface $product The product to be purchased.
-     * @param bool $force [optional] Whether to force the purchase. Defaults to false.
-     * @return Transfer|null The transfer object representing the purchase, or null if the purchase fails.
+     * @return Transfer The transfer object representing the purchase.
      *
      * @throws ProductEnded If the product is ended.
      * @throws BalanceIsEmpty If the balance of the wallet is empty.
      * @throws InsufficientFunds If there are insufficient funds in the wallet.
-     * @throws RecordNotFoundException If the record is not found.
+     * @throws RecordNotFoundException If the wallet or the product record is not found.
      * @throws RecordsNotFoundException If the records are not found.
      * @throws TransactionFailedException If the transaction fails.
+     * @throws ModelNotFoundException If the wallet or the product is not found.
      * @throws ExceptionInterface If an exception occurs.
      */
-    public function payFree(ProductInterface $product): ?Transfer;
+    public function payFree(ProductInterface $product): Transfer;
 
     /**
      * Attempts to purchase a product without payment.

src/Interfaces/Wallet.php

@@ -21,7 +21,7 @@ interface Wallet
     /**
      * Deposit the specified amount of money into the wallet.
      *
-     * @param int|string $amount The amount to deposit.
+     * @param int|non-empty-string $amount The amount to deposit.
      * @param array<mixed>|null $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -36,7 +36,7 @@ public function deposit(int|string $amount, ?array $meta = null, bool $confirmed
     /**
      * Withdraw the specified amount of money from the wallet.
      *
-     * @param int|string $amount The amount to withdraw.
+     * @param int|non-empty-string $amount The amount to withdraw.
      * @param array<mixed>|null $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -53,7 +53,7 @@ public function withdraw(int|string $amount, ?array $meta = null, bool $confirme
     /**
      * Forced to withdraw funds from the wallet.
      *
-     * @param int|string $amount The amount to withdraw.
+     * @param int|non-empty-string $amount The amount to withdraw.
      * @param array<mixed>|null $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -69,7 +69,7 @@ public function forceWithdraw(int|string $amount, ?array $meta = null, bool $con
      * Transfer funds from this wallet to another.
      *
      * @param self $wallet The wallet to transfer funds to.
-     * @param int|string $amount The amount to transfer.
+     * @param int|non-empty-string $amount The amount to transfer.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional information for the transaction.
      * @return Transfer The created transaction.
      *
@@ -89,7 +89,7 @@ public function transfer(self $wallet, int|string $amount, ExtraDtoInterface|arr
      * If an error occurs during the process, null is returned.
      *
      * @param self $wallet The wallet to transfer funds to.
-     * @param int|string $amount The amount to transfer.
+     * @param int|non-empty-string $amount The amount to transfer.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional information for the transaction.
      *                                                This can be an instance of an ExtraDtoInterface
      *                                                or an array of arbitrary data.
@@ -116,7 +116,7 @@ public function safeTransfer(
      * method with caution as it can result in negative balances or other unintended consequences.
      *
      * @param self $wallet The wallet instance to which funds will be transferred.
-     * @param int|string $amount The amount of funds to transfer. Can be specified as an integer or a string.
+     * @param int|non-empty-string $amount The amount of funds to transfer. Can be specified as an integer or a string.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional metadata associated with the transfer. This
      * can be used to store extra information about the transaction, such as reasons for the transfer or
      * identifiers linking to other systems.
@@ -138,7 +138,7 @@ public function forceTransfer(
     /**
      * Checks if the wallet can safely withdraw the specified amount.
      *
-     * @param int|string $amount The amount to withdraw.
+     * @param int|non-empty-string $amount The amount to withdraw.
      * @param bool $allowZero Whether to allow withdrawing when the balance is zero.
      * @return bool Returns true if the wallet can withdraw the specified amount, false otherwise.
      */

src/Interfaces/WalletFloat.php

@@ -19,7 +19,7 @@ interface WalletFloat
     /**
      * Deposit a float amount of money into the wallet.
      *
-     * @param float|int|string $amount The amount to deposit.
+     * @param float|int|non-empty-string $amount The amount to deposit.
      * @param null|array<mixed> $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -38,7 +38,7 @@ public function depositFloat(
     /**
      * Withdraw the specified float amount of money from the wallet.
      *
-     * @param float|int|string $amount The amount to withdraw.
+     * @param float|int|non-empty-string $amount The amount to withdraw.
      * @param array<mixed>|null $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -59,7 +59,7 @@ public function withdrawFloat(
     /**
      * Forced to withdraw funds from the wallet.
      *
-     * @param float|int|string $amount The amount to withdraw.
+     * @param float|int|non-empty-string $amount The amount to withdraw.
      * @param null|array<mixed> $meta Additional information for the transaction.
      * @param bool $confirmed Whether the transaction is confirmed or not.
      * @return Transaction The created transaction.
@@ -79,7 +79,7 @@ public function forceWithdrawFloat(
      * Transfer funds from this wallet to another.
      *
      * @param Wallet $wallet The wallet to transfer funds to.
-     * @param float|int|string $amount The amount to transfer.
+     * @param float|int|non-empty-string $amount The amount to transfer.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional information for the transaction.
      *                                                This can be an instance of an ExtraDtoInterface
      *                                                or an array of arbitrary data.
@@ -104,7 +104,7 @@ public function transferFloat(
      * This method will not throw an exception if the transfer fails. Instead, it will return null.
      *
      * @param Wallet $wallet The wallet to transfer funds to.
-     * @param float|int|string $amount The amount to transfer.
+     * @param float|int|non-empty-string $amount The amount to transfer.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional information for the transaction.
      *                                                This can be an instance of an ExtraDtoInterface
      *                                                or an array of arbitrary data.
@@ -126,7 +126,7 @@ public function safeTransferFloat(
      * method with caution as it can result in negative balances or other unintended consequences.
      *
      * @param Wallet $wallet The wallet instance to which funds will be transferred.
-     * @param float|int|string $amount The amount of funds to transfer. Can be specified as a float, int, or string.
+     * @param float|int|non-empty-string $amount The amount of funds to transfer. Can be specified as a float, int, or string.
      * @param ExtraDtoInterface|array<mixed>|null $meta Additional metadata associated with the transfer. This
      * can be used to store extra information about the transaction, such as reasons for the transfer or
      * identifiers linking to other systems.
@@ -148,7 +148,7 @@ public function forceTransferFloat(
     /**
      * Checks if the user can withdraw the specified amount of funds.
      *
-     * @param float|int|string $amount The amount of funds to withdraw. Can be specified as a float, int, or string.
+     * @param float|int|non-empty-string $amount The amount of funds to withdraw. Can be specified as a float, int, or string.
      * @return bool Returns TRUE if the withdrawal is possible, FALSE otherwise.
      *
      * @throws AmountInvalid If the amount is invalid (e.g., negative values).
@@ -161,7 +161,7 @@ public function canWithdrawFloat(float|int|string $amount): bool;
      * This method returns the balance of the wallet as a string. The balance is the total amount of funds
      * held by the wallet.
      *
-     * @return string The user's current balance as a string (e.g. "1.23").
+     * @return non-empty-string The user's current balance as a string (e.g. "1.23").
      */
     public function getBalanceFloatAttribute(): string;
 

src/Internal/Assembler/OptionDtoAssemblerInterface.php

@@ -11,7 +11,7 @@ interface OptionDtoAssemblerInterface
     /**
      * Create an OptionDto object from the given data.
      *
-     * @param array|null $data The data to create the OptionDto from.
+     * @param array<mixed>|null $data The data to create the OptionDto from.
      *                        This can be null, in which case an empty
      *                        OptionDto object will be created.
      * @return OptionDtoInterface The created OptionDto object.