Add some experimental account endpoints using a package

app/Support/JsonApi/Concerns/UsergroupAware.php

@@ -0,0 +1,48 @@
+<?php
+/*
+ * UsergroupAware.php
+ * Copyright (c) 2024 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\Support\JsonApi\Concerns;
+
+use FireflyIII\Models\UserGroup;
+
+trait UsergroupAware
+{
+
+    protected UserGroup $userGroup;
+
+    public function getUserGroup(): UserGroup
+    {
+        return $this->userGroup;
+    }
+
+    public function setUserGroup(UserGroup $userGroup): void
+    {
+        $this->userGroup = $userGroup;
+    }
+
+    public function withUserGroup(UserGroup $userGroup): self {
+        $this->userGroup = $userGroup;
+        return $this;
+    }
+
+}

app/Support/JsonApi/Enrichments/AccountEnrichment.php

@@ -0,0 +1,79 @@
+<?php
+/*
+ * AccountEnricher.php
+ * Copyright (c) 2024 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\Support\JsonApi\Enrichments;
+
+use Carbon\Carbon;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Repositories\UserGroups\Account\AccountRepositoryInterface;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+
+class AccountEnrichment implements EnrichmentInterface
+{
+
+    private Collection $collection;
+
+    #[\Override] public function enrich(Collection $collection): Collection
+    {
+        $this->collection         = $collection;
+
+        // do everything here:
+        $this->getLastActivity();
+        $this->getMetaBalances();
+
+        return $this->collection;
+    }
+
+    /**
+     * TODO this method refers to a single-use method inside Steam that could be moved here.
+     * @return void
+     */
+    private function getLastActivity(): void
+    {
+        /** @var AccountRepositoryInterface $accountRepository */
+        $accountRepository = app(AccountRepositoryInterface::class);
+        $lastActivity      = $accountRepository->getLastActivity($this->collection);
+        foreach ($lastActivity as $row) {
+            $this->collection->where('id', $row['account_id'])->first()->last_activity = Carbon::parse($row['date_max'], config('app.timezone'));
+        }
+    }
+
+    /**
+     * TODO this method refers to a single-use method inside Steam that could be moved here.
+     * @return void
+     */
+    private function getMetaBalances(): void
+    {
+        try {
+            $array = app('steam')->balancesByAccountsConverted($this->collection, today());
+        } catch (FireflyException $e) {
+            Log::error(sprintf('Could not load balances: %s', $e->getMessage()));
+            return;
+        }
+        foreach ($array as $accountId => $row) {
+            $this->collection->where('id', $accountId)->first()->balance = $row['balance'];
+            $this->collection->where('id', $accountId)->first()->native_balance = $row['native_balance'];
+        }
+    }
+}

app/Support/JsonApi/Enrichments/EnrichmentInterface.php

@@ -0,0 +1,32 @@
+<?php
+/*
+ * EnricherInterface.php
+ * Copyright (c) 2024 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\Support\JsonApi\Enrichments;
+
+use Illuminate\Support\Collection;
+
+interface EnrichmentInterface
+{
+    public function enrich(Collection $collection): Collection;
+
+}

app/Support/JsonApi/ExpandsQuery.php

@@ -0,0 +1,68 @@
+<?php
+/*
+ * ExpandsQuery.php
+ * Copyright (c) 2024 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\Support\JsonApi;
+
+use Illuminate\Contracts\Database\Eloquent\Builder;
+use LaravelJsonApi\Core\Query\FilterParameters;
+use LaravelJsonApi\Core\Query\SortFields;
+
+trait ExpandsQuery
+{
+    final protected function addPagination(Builder $query, array $pagination): Builder
+    {
+        $skip = ($pagination['number'] - 1) * $pagination['size'];
+        return $query->skip($skip)->take($pagination['size']);
+    }
+
+    final protected function addSortParams(Builder $query, SortFields $sort): Builder
+    {
+        foreach ($sort->all() as $sortField) {
+            $query->orderBy($sortField->name(), $sortField->isAscending() ? 'ASC' : 'DESC');
+        }
+        return $query;
+    }
+
+    final protected function addFilterParams(string $class, Builder $query, ?FilterParameters $filters): Builder
+    {
+        if (null === $filters) {
+            return $query;
+        }
+        $config = config(sprintf('firefly.valid_query_filters.%s', $class)) ?? [];
+        if (count($filters->all()) === 0) {
+            return $query;
+        }
+        $query->where(function (Builder $q) use ($config, $filters) {
+            foreach ($filters->all() as $filter) {
+                if (in_array($filter->key(), $config, true)) {
+                    foreach($filter->value() as $value) {
+                        $q->where($filter->key(), 'LIKE', sprintf('%%%s%%', $value));
+                    }
+                }
+            }
+        });
+
+        return $query;
+    }
+
+}

app/Support/JsonApi/FiltersPagination.php

@@ -0,0 +1,55 @@
+<?php
+/*
+ * FiltersPagination.php
+ * Copyright (c) 2024 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\Support\JsonApi;
+
+trait FiltersPagination
+{
+
+    protected function filtersPagination(?array $pagination): array
+    {
+        if (null === $pagination) {
+            return [
+                'number' => 1,
+                'size'   => $this->getPageSize(),
+            ];
+        }
+        // cleanup page number
+        $pagination['number'] = (int) ($pagination['number'] ?? 1);
+        $pagination['number'] = min(65536, max($pagination['number'], 1));
+
+        // clean up page size
+        $pagination['size'] = (int) ($pagination['size'] ?? $this->getPageSize());
+        $pagination['size'] = min(1337, max($pagination['size'], 1));
+
+        return $pagination;
+    }
+
+    private function getPageSize(): int
+    {
+        if (auth()->check()) {
+            return (int) app('preferences')->get('listPageSize', 50)->data;
+        }
+        return 50;
+    }
+}

app/Support/JsonApi/SortsCollection.php

@@ -0,0 +1,40 @@
+<?php
+/*
+ * SortsCollection.php
+ * Copyright (c) 2024 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\Support\JsonApi;
+
+use Illuminate\Support\Collection;
+use LaravelJsonApi\Core\Query\SortFields;
+
+trait SortsCollection
+{
+    protected function sortCollection(Collection $collection, SortFields $sortFields): Collection {
+
+        foreach($sortFields->all() as $sortField) {
+            $collection = $sortField->isAscending() ? $collection->sortBy($sortField->name()) :  $collection->sortByDesc($sortField->name());
+        }
+
+        return $collection;
+    }
+
+}

app/Support/JsonApi/ValidateSortParameters.php

@@ -0,0 +1,43 @@
+<?php
+/*
+ * ValidateSortParameters.php
+ * Copyright (c) 2024 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\Support\JsonApi;
+
+use LaravelJsonApi\Core\Query\SortFields;
+
+trait ValidateSortParameters
+{
+    function validateParams(string $class, SortFields $params): bool
+    {
+
+        $config = config(sprintf('firefly.full_data_set.%s', $class)) ?? [];
+
+        foreach ($params->all() as $field) {
+            if (in_array($field->name(), $config, true)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+}