@flarum/cli 2.0.2 → 3.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021-2022 Stichting Flarum (Flarum Foundation)
+Copyright (c) 2021-2024 Stichting Flarum (Flarum Foundation)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -26,7 +26,7 @@ This tool was built to simplify the development of Flarum extensions by automati
 <!-- installation -->
 
 ```sh-session
-$ npm install -g @flarum/cli@^2.0.0
+$ npm install -g @flarum/cli@^3.0.0
 ```
 
 <!-- installationstop -->
@@ -49,7 +49,7 @@ $ npm install -g @flarum/cli
 $ flarum-cli COMMAND
 running command...
 $ flarum-cli (-v|--version|version)
-@flarum/cli/2.0.2 linux-x64 node-v18.19.1
+@flarum/cli/3.0.1 linux-x64 node-v18.19.1
 $ flarum-cli --help [COMMAND]
 USAGE
   $ flarum-cli COMMAND
@@ -83,33 +83,51 @@ The CLI has different types of commands for different tasks:
 
 - `flarum-cli infra [MODULE] [PATH]`: Adds (or updates) infrastructure for some part of extension infrastructure. You can see all available modules by running `fl-dev infra --help`.
 
-**Audit**: These commands help you make sure your extension is up to date.
+**Audit**: These commands help you make sure your extension is up-to-date.
 
-- `flarum-cli audit infra [--monorepo] [--fix]` Check that infrastructure files are up to date for all enabled modules.
+- `flarum-cli audit infra [--monorepo] [--fix]` Check that infrastructure files are up-to-date for all enabled modules.
+
+**Backend/Frontend Boilerplate Generation**: These commands generate boilerplate code for different parts of an extension.
+
+- `flarum-cli make model [className] [PATH] [-n|--no-interaction]`: Generates a backend model, the corresponding table migration, policy, API resource, routes, frontend equivalent, and related extenders.
+- `flarum-cli make notification [className] [PATH] [-n|--no-interaction]`: Generates a backend notification blueprint, the corresponding backend extender, and the frontend equivalent.
+- `flarum-cli make post-type [className] [PATH] [-n|--no-interaction]`: Generates a post type, the corresponding extenders, and the frontend equivalent.
+
+**Localized text generation**: This command generates a locale key-value pair for a given string.
+
+- `flarum-cli make locale [key] [value] [PATH] [-n|--no-interaction]`
 
 **Backend Boilerplate Generation**: Generates different types of backend classes and/or extenders, ready to be used.
 
-- `flarum-cli make backend api-controller [PATH]`
-- `flarum-cli make backend api-serializer [PATH]`
-- `flarum-cli make backend api-serializer-attributes [PATH]`
-- `flarum-cli make backend command [PATH]`
-- `flarum-cli make backend event-listener [PATH]`
-- `flarum-cli make backend handler [PATH]`
-- `flarum-cli make backend integration-test [PATH]`
-- `flarum-cli make backend job [PATH]`
-- `flarum-cli make backend migration [PATH]`
-- `flarum-cli make backend model [PATH]`
-- `flarum-cli make backend policy [PATH]`
-- `flarum-cli make backend repository [PATH]`
-- `flarum-cli make backend route [PATH]`
-- `flarum-cli make backend service-provider [PATH]`
-- `flarum-cli make backend validator [PATH]`
+- `flarum-cli make backend model [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend controller [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend api-resource [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend command [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend event-listener [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend handler [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend integration-test [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend job [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend migration [name] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend policy [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend repository [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend route [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend service-provider [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend validator [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend filter [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend notification-blueprint [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend notification-driver [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend post-type [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make backend mail-driver [className] [PATH] [-n|--no-interaction]`
 
 **Frontend Boilerplate Generation**: Generate frontend components/classes, ready to be used.
 
-- `flarum-cli make frontend component [PATH]`
-- `flarum-cli make frontend modal [PATH]`
-- `flarum-cli make frontend model [PATH]`
+- `flarum-cli make frontend component [frontend] [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend modal [frontend] [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend model [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend forum-page [className] [routeName] [routePath] [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend gambit [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend notification [className] [PATH] [-n|--no-interaction]`
+- `flarum-cli make frontend post-type [className] [PATH] [-n|--no-interaction]`
 
 **Code Updates**: These commands help update extensions for newer versions of Flarum.
 

package/boilerplate/skeleton/extension/.github/workflows/backend.yml

@@ -4,7 +4,7 @@ on: [workflow_dispatch, push, pull_request]
 
 jobs:
   run:
-    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@2.x
     with:
       enable_backend_testing: <%= modules.backendTesting %>
 

package/boilerplate/skeleton/extension/.github/workflows/frontend.yml

@@ -4,11 +4,12 @@ on: [workflow_dispatch, push, pull_request]
 
 jobs:
   run:
-    uses: flarum/framework/.github/workflows/REUSABLE_frontend.yml@main
+    uses: flarum/framework/.github/workflows/REUSABLE_frontend.yml@2.x
     with:
       enable_bundlewatch: <%= modules.bundlewatch %>
       enable_prettier: <%= modules.prettier %>
       enable_typescript: <%= modules.typescript %>
+      enable_tests: <%= modules.frontendTesting %>
 
       frontend_directory: <%= params.frontendDirectory %>
       backend_directory: <%= params.backendDirectory %>

package/boilerplate/skeleton/extension/.github/workflows/phpstan.yml

@@ -0,0 +1,12 @@
+name: Static Code Analysis
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@2.x
+    with:
+      enable_backend_testing: false
+      enable_phpstan: <%= modules.phpstan %>
+
+      backend_directory: <%= params.backendDirectory %>

package/boilerplate/skeleton/extension/composer.json

@@ -7,10 +7,11 @@
     "type": "flarum-extension",
     "license": "<%= params.licenseType %>",
     "require": {
-        "flarum/core": "^1.2.0"
+        "flarum/core": "^2.0"
     },
     "require-dev": {
-        "flarum/testing": "^1.0.0"
+        "flarum/testing": "^2.0",
+        "flarum/phpstan": "^2.0"
     },
     "authors": [<% if (params.authorName) { %>
         {
@@ -49,13 +50,16 @@
         ],
         "test:unit": "phpunit -c tests/phpunit.unit.xml",
         "test:integration": "phpunit -c tests/phpunit.integration.xml",
-        "test:setup": "@php tests/integration/setup.php"
+        "test:setup": "@php tests/integration/setup.php",
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
     },
     "scripts-descriptions": {
         "test": "Runs all tests.",
         "test:unit": "Runs all unit tests.",
         "test:integration": "Runs all integration tests.",
-        "test:setup": "Sets up a database for use with integration tests. Execute this only once."
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once.",
+        "analyse:phpstan": "Run static analysis"
     },
     "minimum-stability": "dev",
     "prefer-stable": true

package/boilerplate/skeleton/extension/gitignore

@@ -4,6 +4,7 @@ composer.phar
 
 .DS_Store
 Thumbs.db
+tests/.phpunit.cache
 tests/.phpunit.result.cache
 /tests/integration/tmp
 .vagrant

package/boilerplate/skeleton/extension/js/jest.config.cjs

@@ -0,0 +1 @@
+module.exports = require('@flarum/jest-config')({});

package/boilerplate/skeleton/extension/js/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@<%= params.packageName %>",
   "private": true,
+  "type": "module",
   "version": "0.0.0",
   "prettier": "@flarum/prettier-config",
   "dependencies": {
   },
   "devDependencies": {
+    "@flarum/jest-config": "^1.0.1",
     "@flarum/prettier-config": "^1.0.0",
-    "flarum-tsconfig": "^1.0.2",
-    "flarum-webpack-config": "^2.0.0",
+    "flarum-tsconfig": "^2.0.0",
+    "flarum-webpack-config": "^3.0.0",
     "prettier": "^2.5.1",
     "typescript": "^4.5.4",
     "typescript-coverage-report": "^0.6.1",
@@ -25,6 +27,7 @@
     "build-typings": "<%= params.jsPackageManager %> run clean-typings && ([ -e src/@types ] && cp -r src/@types dist-typings/@types || true) && tsc && <%= params.jsPackageManager %> run post-build-typings",
     "post-build-typings": "find dist-typings -type f -name '*.d.ts' -print0 | xargs -0 sed -i 's,../src/@types,@types,g'",
     "check-typings": "tsc --noEmit --emitDeclarationOnly false",
-    "check-typings-coverage": "typescript-coverage-report"
+    "check-typings-coverage": "typescript-coverage-report",
+    "test": "yarn node --experimental-vm-modules $(yarn bin jest)"
   }
 }

package/boilerplate/skeleton/extension/js/src/admin/extend.js

@@ -0,0 +1,8 @@
+import Extend from 'flarum/common/extenders';
+import commonExtend from '../common/extend';
+
+export default [
+  ...commonExtend,
+
+  // Add your admin extenders here
+];

package/boilerplate/skeleton/extension/js/src/admin/extend.ts

@@ -0,0 +1,8 @@
+import Extend from 'flarum/common/extenders';
+import commonExtend from '../common/extend';
+
+export default [
+  ...commonExtend,
+
+  // Add your admin extenders here
+];

package/boilerplate/skeleton/extension/js/src/admin/index.js

@@ -1,5 +1,7 @@
 import app from 'flarum/admin/app';
 
+export { default as extend } from './extend';
+
 app.initializers.add('<%= params.packageName %>', () => {
   console.log('[<%= params.packageName %>] Hello, admin!');
 });

package/boilerplate/skeleton/extension/js/src/admin/index.ts

@@ -1,5 +1,7 @@
 import app from 'flarum/admin/app';
 
-app.initializers.add('<%= params.packageName %>', () => {
+export { default as extend } from './extend';
+
+app.initializers.add('<%= params.extensionId %>', () => {
   console.log('[<%= params.packageName %>] Hello, admin!');
 });

package/boilerplate/skeleton/extension/js/src/common/extend.js

@@ -0,0 +1,5 @@
+import Extend from 'flarum/common/extenders';
+
+export default [
+  // Add your common extenders here
+];

package/boilerplate/skeleton/extension/js/src/common/extend.ts

@@ -0,0 +1,5 @@
+import Extend from 'flarum/common/extenders';
+
+export default [
+  // Add your common extenders here
+];

package/boilerplate/skeleton/extension/js/src/common/index.ts

@@ -1,5 +1,5 @@
 import app from 'flarum/common/app';
 
-app.initializers.add('<%= params.packageName %>', () => {
+app.initializers.add('<%= params.extensionId %>-common', () => {
   console.log('[<%= params.packageName %>] Hello, forum and admin!');
 });

package/boilerplate/skeleton/extension/js/src/forum/extend.js

@@ -0,0 +1,8 @@
+import Extend from 'flarum/common/extenders';
+import commonExtend from '../common/extend';
+
+export default [
+  ...commonExtend,
+
+  // Add your forum extenders here
+];

package/boilerplate/skeleton/extension/js/src/forum/extend.ts

@@ -0,0 +1,8 @@
+import Extend from 'flarum/common/extenders';
+import commonExtend from '../common/extend';
+
+export default [
+  ...commonExtend,
+
+  // Add your forum extenders here
+];

package/boilerplate/skeleton/extension/js/src/forum/index.js

@@ -1,5 +1,7 @@
 import app from 'flarum/forum/app';
 
+export { default as extend } from './extend';
+
 app.initializers.add('<%= params.packageName %>', () => {
   console.log('[<%= params.packageName %>] Hello, forum!');
 });

package/boilerplate/skeleton/extension/js/src/forum/index.ts

@@ -1,5 +1,7 @@
 import app from 'flarum/forum/app';
 
-app.initializers.add('<%= params.packageName %>', () => {
+export { default as extend } from './extend';
+
+app.initializers.add('<%= params.extensionId %>', () => {
   console.log('[<%= params.packageName %>] Hello, forum!');
 });

package/boilerplate/skeleton/extension/js/tsconfig.test.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "include": ["tests/**/*"],
+    "files": ["../../../node_modules/@flarum/jest-config/shims.d.ts"],
+    "compilerOptions": {
+        "strict": false,
+        "noImplicitReturns": false,
+        "noImplicitAny": false
+    }
+}

package/boilerplate/skeleton/extension/locale/en.yml

@@ -1,6 +1,6 @@
 <%= params.extensionId %>:
   # For more details on the format
-  # Checkout https://docs.flarum.org/extend/i18n/#appendix-a-standard-key-format
+  # Checkout https://docs.flarum.org/2.x/extend/i18n/#appendix-a-standard-key-format
   admin:
     my_cool_key: My Cool Key
 

package/boilerplate/skeleton/extension/phpstan.neon

@@ -0,0 +1,12 @@
+includes:
+  - vendor/flarum/phpstan/extension.neon
+
+parameters:
+  level: 6
+  paths:
+    - extend.php
+    - src
+  excludePaths:
+    - *.blade.php
+  checkMissingIterableValueType: false
+  databaseMigrationsPath: ['migrations']

package/boilerplate/skeleton/extension/tests/phpunit.integration.xml

@@ -1,21 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="../vendor/phpunit/phpunit/phpunit.xsd"
     backupGlobals="false"
-    backupStaticAttributes="false"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
     colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
     processIsolation="true"
     stopOnFailure="false"
 >
-    <coverage processUncoveredFiles="true">
+    <source>
         <include>
             <directory suffix=".php">../src/</directory>
         </include>
-    </coverage>
+    </source>
     <testsuites>
         <testsuite name="Flarum Integration Tests">
             <directory suffix="Test.php">./integration</directory>

package/boilerplate/skeleton/extension/tests/phpunit.unit.xml

@@ -1,27 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
     backupGlobals="false"
-    backupStaticAttributes="false"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
     colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
 >
-    <coverage processUncoveredFiles="true">
+    <source>
         <include>
             <directory suffix=".php">../src/</directory>
         </include>
-    </coverage>
+    </source>
     <testsuites>
         <testsuite name="Flarum Unit Tests">
             <directory suffix="Test.php">./unit</directory>
         </testsuite>
     </testsuites>
-    <listeners>
-        <listener class="\Mockery\Adapter\Phpunit\TestListener" />
-    </listeners>
 </phpunit>

package/boilerplate/stubs/backend/advanced-api-resource.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Api\Context;
+use Flarum\Api\Endpoint;
+use Flarum\Api\Resource;
+use Flarum\Api\Schema;<% if (modelClassName) { %>
+use Flarum\Api\Sort\SortColumn;
+use <%= modelClass %>;
+use Illuminate\Database\Eloquent\Builder;<% } %>
+use Tobyz\JsonApiServer\Context as OriginalContext;
+
+/**
+ * @extends <% if (modelClassName) { %>Resource\AbstractDatabaseResource<<%= modelClassName %>><% } else { %>Resource\AbstractResource<object><% } %>
+ */
+class <%= className %> extends <% if (modelClassName) { %>Resource\AbstractDatabaseResource<% } else { %>Resource\AbstractResource<% if (interfaces.length > 0) %> implements <%= interfaces.join(', ') %><% } %>
+{
+    public function type(): string
+    {
+        return '<%= modelType %>';
+    }<% if (modelClassName) { %>
+
+    public function model(): string
+    {
+        return <%= modelClassName %>::class;
+    }
+
+    public function scope(Builder $query, OriginalContext $context): void
+    {
+        $query->whereVisibleTo($context->getActor());
+    }<% } %>
+
+    public function endpoints(): array
+    {
+        return [<% if (endpoints.includes('create')) { %>
+            Endpoint\Create::make()<% if (modelClassName) { %>
+                ->can('create<%= modelClassName %>'),<% } %><% } %><% if (endpoints.includes('update')) { %>
+            Endpoint\Update::make()
+                ->can('update'),<% } %><% if (endpoints.includes('delete')) { %>
+            Endpoint\Delete::make()
+                ->can('delete'),<% } %><% if (endpoints.includes('show')) { %>
+            Endpoint\Show::make()
+                ->authenticated(),<% } %><% if (endpoints.includes('list')) { %>
+            Endpoint\Index::make()
+                ->paginate(),<% } %>
+        ];
+    }
+
+    public function fields(): array
+    {
+        return [
+
+            /**
+             * @todo migrate logic from old serializer and controllers to this API Resource.
+             * @see https://docs.flarum.org/2.x/extend/api#api-resources
+             */
+
+            // Example:
+            Schema\Str::make('name')
+                ->requiredOnCreate()
+                ->minLength(3)
+                ->maxLength(255)
+                ->writable(),
+
+<% (relations || []).forEach(([name,type]) => { %>
+            Schema\Relationship\<% if (type === 'hasOne') { %>ToOne<% } else { %>ToMany<% } %>::make('<%= name %>')
+                ->includable()
+                // ->inverse('?') // the inverse relationship name if any.
+                ->type('<%= name %>s'), // the serialized type of this relation (type of the relation model's API resource).<% }) %>
+        ];
+    }<% if (modelClassName) { %>
+
+    public function sorts(): array
+    {
+        return [
+            // SortColumn::make('createdAt'),
+        ];
+    }<% } else { %>
+
+    public function getId(object $model, OriginalContext $context): string
+    {
+        return $model->id;
+    }<% } %>
+}

package/boilerplate/stubs/backend/api-resource.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Api\Context;
+use Flarum\Api\Endpoint;
+use Flarum\Api\Resource;
+use Flarum\Api\Schema;
+use Flarum\Api\Sort\SortColumn;
+use <%= modelClass %>;
+use Illuminate\Database\Eloquent\Builder;
+use Tobyz\JsonApiServer\Context as OriginalContext;
+
+/**
+ * @extends Resource\AbstractDatabaseResource<<%= modelClassName %>>
+ */
+class <%= className %> extends Resource\AbstractDatabaseResource
+{
+    public function type(): string
+    {
+        return '<%= modelType %>';
+    }
+
+    public function model(): string
+    {
+        return <%= modelClassName %>::class;
+    }
+
+    public function scope(Builder $query, OriginalContext $context): void
+    {
+        $query->whereVisibleTo($context->getActor());
+    }
+
+    public function endpoints(): array
+    {
+        return [
+            Endpoint\Create::make()
+                ->can('create<%= modelClassName %>'),
+            Endpoint\Update::make()
+                ->can('update'),
+            Endpoint\Delete::make()
+                ->can('delete'),
+            Endpoint\Show::make()
+                ->authenticated(),
+            Endpoint\Index::make()
+                ->paginate(),
+        ];
+    }
+
+    public function fields(): array
+    {
+        return [
+
+            /**
+             * @see https://docs.flarum.org/2.x/extend/api#api-resources
+             */
+
+            // Example:
+            Schema\Str::make('name')
+                ->requiredOnCreate()
+                ->minLength(3)
+                ->maxLength(255)
+                ->writable(),
+        ];
+    }
+
+    public function sorts(): array
+    {
+        return [
+            SortColumn::make('createdAt'),
+        ];
+    }
+}

package/boilerplate/stubs/backend/command.php

@@ -13,9 +13,9 @@ class <%= className %> extends AbstractCommand
             ->setDescription('<%= commandDescription %>');
     }
 
-    protected function fire()
+    protected function fire(): int
     {
-        // See https://docs.flarum.org/extend/console.html#console and
+        // See https://docs.flarum.org/2.x/extend/console.html#console and
         // https://symfony.com/doc/current/console.html#configuring-the-command for more information.
     }
 }

package/boilerplate/stubs/backend/controller.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Http\RequestUtil;
+use Laminas\Diactoros\Response;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+class <%= className %> implements RequestHandlerInterface
+{
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        $actor = RequestUtil::getActor($request);
+
+        return new Response(200);
+    }
+}

package/boilerplate/stubs/backend/event-listener.php

@@ -9,6 +9,6 @@ class <%= className %>
     public function handle(<%= eventClassName %> $event)
     {
         // Add logic to handle the event here.
-        // See https://docs.flarum.org/extend/backend-events.html for more information.
+        // See https://docs.flarum.org/2.x/extend/backend-events.html for more information.
     }
 }

package/boilerplate/stubs/backend/filter.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Search\Database\DatabaseSearchState;
+use Flarum\Search\Filter\FilterInterface;
+use Flarum\Search\SearchState;
+use Flarum\User\User;
+use Illuminate\Database\Query\Builder;
+
+/**
+ * @implements FilterInterface<DatabaseSearchState>
+ */
+class <%= className %> implements FilterInterface
+{
+    public function getFilterKey(): string
+    {
+        return '<%= filterKey %>';
+    }
+
+    public function filter(SearchState $state, string|array $value, bool $negate): void
+    {
+        // @TODO: implement filter logic
+    }
+}