@flarum/cli 2.0.0-beta.8 → 3.0.0

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

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

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

@@ -4,13 +4,21 @@
   // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
   // and also tells your Typescript server to read core's global typings for
   // access to `dayjs` and `$` in the global namespace.
-  "include": ["src/**/*", "../vendor/flarum/core/js/dist-typings/@types/**/*", "@types/**/*"],
+  "include": [
+      "src/**/*",
+      "../vendor/*/*/js/dist-typings/@types/**/*",
+// <CUSTOM-1>
+// </CUSTOM-1>
+      "@types/**/*"
+],
   "compilerOptions": {
     // This will output typings to `dist-typings`
     "declarationDir": "./dist-typings",
     "baseUrl": ".",
     "paths": {
-      "flarum/*": ["../vendor/flarum/core/js/dist-typings/*"]
+      "flarum/*": ["../vendor/flarum/core/js/dist-typings/*"],
+// <CUSTOM-2>
+// </CUSTOM-2>
     }
   }
 }

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.html#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,24 +1,23 @@
 <?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>
+             <exclude>./integration/tmp</exclude>
         </testsuite>
     </testsuites>
 </phpunit>

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
+    }
+}

package/boilerplate/stubs/backend/handler/command.php

@@ -5,26 +5,12 @@ namespace <%= classNamespace %>;
 use Flarum\User\User;
 
 class <%= className %>
-{<% if (!['create', 'none'].includes(classType)) { %>
-    /**
-     * @var int
-     */
-    public $modelId;
+{
+    public function __construct(<% if (!['create', 'none'].includes(classType)) { %>
+        public int $modelId;
 <% } %>
-    /**
-     * @var \Flarum\User\User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    public function __construct(<%= !['create', 'none'].includes(classType) ? '$modelId, ' : '' %>User $actor, array $data)
-    {<% if (!['create', 'none'].includes(classType)) { %>
-        $this->modelId = $modelId;<% } %>
-        $this->actor = $actor;
-        $this->data = $data;
+        public User $actor;
+        public array $data;
+    ) {
     }
 }

package/boilerplate/stubs/backend/handler/handler.php

@@ -5,22 +5,14 @@ namespace <%= classNamespace %>;
 use Illuminate\Support\Arr;<% if (locals.repositoryClassName) { %>
 use <%= repositoryClass %>;<% } %><% if (locals.validatorClassName) { %>
 use <%= validatorClass %>;<% } %>
-<% const dependencies = [locals.repositoryClassName && [repositoryClassName, 'repository'] || null, locals.validatorClassName && [validatorClassName, 'validator'] || null].filter(item => item !== null) %>
+
 class <%= className %>
-{<% if (locals.repositoryClassName) { %>
-    /**
-     * @var <%= repositoryClassName %>
-     */
-    protected $repository;
+{
+    public function __construct(<% if (locals.repositoryClassName) { %>
+        protected <%= repositoryClassName %> $repository;
 <% } %><% if (locals.validatorClassName) { %>
-    /**
-     * @var <%= validatorClassName %>
-     */
-    protected $validator;
-<% } %>
-    public function __construct(<%= dependencies.map(item => `${item[0]} $${item[1]}`).join(', ') %>)
-    {
-        <%- dependencies.map(item => `$this->${item[1]} = $${item[1]};`).join("\n\t\t") %>
+        protected <%= validatorClassName %> $validator;
+<% } %>) {
     }
 
     public function handle(<%= handlerCommandClassName %> $command)

package/boilerplate/stubs/backend/integration-test.php

@@ -3,8 +3,11 @@
 namespace <%= classNamespace %>;
 
 use Carbon\Carbon;
+use Flarum\Discussion\Discussion;
 use Flarum\Testing\integration\RetrievesAuthorizedUsers;
 use Flarum\Testing\integration\TestCase;
+use Flarum\User\User;
+use PHPUnit\Framework\Attributes\Test;
 
 class <%= className %> extends TestCase
 {
@@ -17,18 +20,18 @@ class <%= className %> extends TestCase
         $this->extension('<%= extensionId %>');
 
         $this->prepareDatabase([
-            'users' => [
-                ['id' => 1, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
+            User::class => [
+                ['id' => 3, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
             ],
-            'discussions' => [
-                ['id' => 1, 'title' => __CLASS__, 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+            Discussion::class => [
+                ['id' => 1, 'title' => __CLASS__, 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 3, 'first_post_id' => 1, 'comment_count' => 1],
             ],
         ]);
     }
 
-    /** @test */
-    public function test_works()
+    #[Test]
+    public function works_as_expected()
     {
-        // See https://docs.flarum.org/extend/testing.html#backend-tests for more information.
+        // See https://docs.flarum.org/2.x/extend/testing.html#backend-tests for more information.
     }
 }

package/boilerplate/stubs/backend/job.php

@@ -2,22 +2,17 @@
 
 namespace <%= classNamespace %>;
 
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\SerializesModels;
+use Flarum\Queue\AbstractJob;
 
-class <%= className %> implements ShouldQueue
+class <%= className %>
 {
-    use Queueable;
-    use SerializesModels;
-
-    public function __construct()
-    {
-        // ...
+    public function __construct(
+        //
+    ) {
     }
 
     public function handle()
     {
-        // See https://laravel.com/docs/8.x/queues for more information.
+        // See https://laravel.com/docs/11.x/queues for more information.
     }
 }

package/boilerplate/stubs/backend/mail-driver.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Settings\SettingsRepositoryInterface;
+use Illuminate\Contracts\Validation\Factory;
+use Illuminate\Support\MessageBag;
+use Symfony\Component\Mailer\Transport\Dsn;
+use Symfony\Component\Mailer\Transport\TransportInterface;
+
+class <%= className %> implements DriverInterface
+{
+    public function availableSettings(): array
+    {
+        return [
+            //
+        ];
+    }
+
+    public function validate(SettingsRepositoryInterface $settings, Factory $validator): MessageBag
+    {
+        return $validator->make($settings->all(), [
+            //
+        ])->errors();
+    }
+
+    public function canSend(): bool
+    {
+        return true;
+    }
+
+    public function buildTransport(SettingsRepositoryInterface $settings): TransportInterface
+    {
+        //
+    }
+}

package/boilerplate/stubs/backend/middleware.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Post\Exception\FloodingException;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Psr\Http\Server\MiddlewareInterface as Middleware;
+use Psr\Http\Server\RequestHandlerInterface as Handler;
+
+class <%= className %> implements Middleware
+{
+    public function process(Request $request, Handler $handler): Response
+    {
+        // do something with the request
+
+        return $handler->handle($request);
+    }
+}

package/boilerplate/stubs/backend/model.php

@@ -8,7 +8,7 @@ use Flarum\Foundation\EventGeneratorTrait;
 
 class <%= className %> extends AbstractModel
 {
-    // See https://docs.flarum.org/extend/models.html#backend-models for more information.
+    // See https://docs.flarum.org/2.x/extend/models.html#backend-models for more information.
     <% if (tableName) { %>
     protected $table = '<%= tableName %>';<% } %>
 }

package/boilerplate/stubs/backend/notification-blueprint.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Database\AbstractModel;
+use Flarum\Notification\Blueprint\BlueprintInterface;
+use Flarum\Notification\AlertableInterface;
+// use Flarum\Notification\MailableInterface;
+use Flarum\User\User;
+
+class <%= className %> implements BlueprintInterface, AlertableInterface/*, MailableInterface*/
+{
+    public function __construct(
+
+    ) {
+    }
+
+    public function getFromUser(): ?User
+    {
+        // @TODO: implement
+    }
+
+    public function getSubject(): ?AbstractModel
+    {
+        // @TODO: implement
+    }
+
+    public function getData(): array
+    {
+        return [];
+    }
+
+    public static function getType(): string
+    {
+        return '<%= type %>';
+    }
+
+    public static function getSubjectModel(): string
+    {
+        // @TODO: implement
+    }
+}

package/boilerplate/stubs/backend/notification-driver.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Notification\Blueprint\BlueprintInterface;
+use Flarum\Notification\Driver\NotificationDriverInterface;
+use Illuminate\Contracts\Queue\Queue;
+use <%= packageNamespace %>\Jobs\SendNotificationsJob;
+
+class <%= className %> implements NotificationDriverInterface
+{
+    public function __construct(
+        protected Queue $queue
+    ) {
+    }
+
+    public function send(BlueprintInterface $blueprint, array $users): void
+    {
+        // The `send` method is responsible for determining any notifications need to be sent.
+        // If not (for example, if there are no users to send to), there's no point in scheduling a job.
+        // We HIGHLY recommend that notifications are sent via a queue job for performance reasons.
+        if (count($users)) {
+            $this->queue->push(new SendNotificationsJob($blueprint, $users));
+        }
+    }
+
+    public function registerType(string $blueprintClass, array $driversEnabledByDefault): void
+    {
+        // This method is generally used to register a user preference for this notification.
+        // This is optional.
+    }
+}

package/boilerplate/stubs/backend/policy.php

@@ -10,6 +10,6 @@ class <%= className %> extends AbstractPolicy
 {
     public function can(User $actor, string $ability, <%= modelClassName %> $model)
     {
-        // See https://docs.flarum.org/extend/authorization.html#custom-policies for more information.
+        // See https://docs.flarum.org/2.x/extend/authorization.html#custom-policies for more information.
     }
 }