Partial implementation of administration aware account auto complete

app/Api/V2/Controllers/Autocomplete/AccountController.php

@@ -25,10 +25,105 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V2\Controllers\Autocomplete;
 
 use FireflyIII\Api\V2\Controllers\Controller;
+use FireflyIII\Api\V2\Request\Autocomplete\AutocompleteRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\Account;
+use FireflyIII\Models\AccountType;
+use FireflyIII\Repositories\Administration\Account\AccountRepositoryInterface as AdminAccountRepositoryInterface;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\Http\Api\AccountFilter;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use JsonException;
 
 /**
  * Class AccountController
  */
 class AccountController extends Controller
 {
+    use AccountFilter;
+
+    private array                      $balanceTypes;
+    private AdminAccountRepositoryInterface $adminRepository;
+    private AccountRepositoryInterface $repository;
+
+    /**
+     * AccountController constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user             = auth()->user();
+                $this->repository = app(AccountRepositoryInterface::class);
+                $this->adminRepository = app(AdminAccountRepositoryInterface::class);
+
+                return $next($request);
+            }
+        );
+        $this->balanceTypes = [AccountType::ASSET, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE,];
+    }
+
+    /**
+     * Documentation for this endpoint:
+     * TODO endpoint is not documented.
+     *
+     * @param  AutocompleteRequest  $request
+     *
+     * @return JsonResponse
+     * @throws JsonException
+     * @throws FireflyException
+     * @throws FireflyException
+     */
+    public function accounts(AutocompleteRequest $request): JsonResponse
+    {
+        $data  = $request->getData();
+        $types = $data['types'];
+        $query = $data['query'];
+        $date  = $data['date'] ?? today(config('app.timezone'));
+        $this->adminRepository->setAdministrationId($data['administration_id']);
+
+        $return          = [];
+        $result          = $this->adminRepository->searchAccount((string)$query, $types, $data['limit']);
+        $defaultCurrency = app('amount')->getDefaultCurrency();
+
+        /** @var Account $account */
+        foreach ($result as $account) {
+            $nameWithBalance = $account->name;
+            $currency        = $this->repository->getAccountCurrency($account) ?? $defaultCurrency;
+
+            if (in_array($account->accountType->type, $this->balanceTypes, true)) {
+                $balance         = app('steam')->balance($account, $date);
+                $nameWithBalance = sprintf('%s (%s)', $account->name, app('amount')->formatAnything($currency, $balance, false));
+            }
+
+            $return[] = [
+                'id'                      => (string)$account->id,
+                'name'                    => $account->name,
+                'name_with_balance'       => $nameWithBalance,
+                'type'                    => $account->accountType->type,
+                'currency_id'             => $currency->id,
+                'currency_name'           => $currency->name,
+                'currency_code'           => $currency->code,
+                'currency_symbol'         => $currency->symbol,
+                'currency_decimal_places' => $currency->decimal_places,
+            ];
+        }
+
+        // custom order.
+        $order = [AccountType::ASSET, AccountType::REVENUE, AccountType::EXPENSE];
+        usort(
+            $return,
+            function ($a, $b) use ($order) {
+                $pos_a = array_search($a['type'], $order, true);
+                $pos_b = array_search($b['type'], $order, true);
+
+                return $pos_a - $pos_b;
+            }
+        );
+
+        return response()->json($return);
+    }
 }

app/Api/V2/Controllers/Controller.php

@@ -79,7 +79,7 @@ class Controller extends BaseController
             $page = 1;
         }
 
-        $integers = ['limit'];
+        $integers = ['limit', 'administration'];
         $dates    = ['start', 'end', 'date'];
 
         if ($page < 1) {

app/Api/V2/Request/Autocomplete/AutocompleteRequest.php

@@ -0,0 +1,98 @@
+<?php
+/*
+ * AutocompleteRequest.php
+ * Copyright (c) 2023 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V2\Request\Autocomplete;
+
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\AccountType;
+use FireflyIII\Models\UserRole;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use FireflyIII\User;
+use FireflyIII\Validation\Administration\ValidatesAdministrationAccess;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Validator;
+
+/**
+ * Class AutocompleteRequest
+ */
+class AutocompleteRequest extends FormRequest
+{
+    use ConvertsDataTypes;
+    use ChecksLogin;
+    use ValidatesAdministrationAccess;
+
+    /**
+     * @return array
+     * @throws FireflyException
+     */
+    public function getData(): array
+    {
+        $types = $this->convertString('types');
+        $array = [];
+        if ('' !== $types) {
+            $array = explode(',', $types);
+        }
+        $limit = $this->convertInteger('limit');
+        $limit = 0 === $limit ? 10 : $limit;
+
+        // remove 'initial balance' and another from allowed types. its internal
+        $array = array_diff($array, [AccountType::INITIAL_BALANCE, AccountType::RECONCILIATION]);
+        /** @var User $user */
+        $user = auth()->user();
+        return [
+            'types'             => $array,
+            'query'             => $this->convertString('query'),
+            'date'              => $this->getCarbonDate('date'),
+            'limit'             => $limit,
+            'administration_id' => (int)($this->get('administration_id', null) ?? $user->getAdministrationId()),
+        ];
+    }
+
+    /**
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'limit' => 'min:0|max:1337',
+        ];
+    }
+
+    /**
+     * Configure the validator instance with special rules for after the basic validation rules.
+     *
+     * @param  Validator  $validator
+     *
+     * @return void
+     */
+    public function withValidator(Validator $validator): void
+    {
+        $validator->after(
+            function (Validator $validator) {
+                // validate if the account can access this administration
+                $this->validateAdministration($validator, [UserRole::CHANGE_TRANSACTIONS]);
+            }
+        );
+    }
+}