First commit

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,4 @@
+js/src export-ignore
+.git* export-ignore
+
+js/dist/*.js -diff

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+vendor
+composer.lock

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Clark Winkelmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,30 @@
+# Meilisearch dashboard
+
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/clarkwinkelmann/flarum-ext-meilisearch-dashboard/blob/master/LICENSE.md) [![Latest Stable Version](https://img.shields.io/packagist/v/clarkwinkelmann/flarum-ext-meilisearch-dashboard.svg)](https://packagist.org/packages/clarkwinkelmann/flarum-ext-meilisearch-dashboard) [![Total Downloads](https://img.shields.io/packagist/dt/clarkwinkelmann/flarum-ext-meilisearch-dashboard.svg)](https://packagist.org/packages/clarkwinkelmann/flarum-ext-meilisearch-dashboard) [![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/clarkwinkelmann)
+
+This is a companion extension for Scout. It provides a proxied access to the Meilisearch HTTP dashboard through Flarum at `/meilisearch/`.
+
+Access control is done through Flarum permissions.
+
+Meilisearch only offers the dashboard when running in development mode.
+In production mode, this extension will just proxy the error page.
+
+## Installation
+
+    composer require clarkwinkelmann/flarum-ext-meilisearch-dashboard
+
+## Support
+
+This extension is under **minimal maintenance**.
+
+It was developed for a client and released as open-source for the benefit of the community.
+I might publish simple bugfixes or compatibility updates for free.
+
+You can [contact me](https://clarkwinkelmann.com/flarum) to sponsor additional features or updates.
+
+Support is offered on a "best effort" basis through the Flarum community thread.
+
+## Links
+
+- [GitHub](https://github.com/clarkwinkelmann/flarum-ext-meilisearch-dashboard)
+- [Packagist](https://packagist.org/packages/clarkwinkelmann/flarum-ext-meilisearch-dashboard)

composer.json

@@ -0,0 +1,42 @@
+{
+    "name": "clarkwinkelmann/flarum-ext-meilisearch-dashboard",
+    "description": "Proxy for Meilisearch HTTP dashboard",
+    "keywords": [
+        "flarum",
+        "meilisearch"
+    ],
+    "type": "flarum-extension",
+    "license": "MIT",
+    "require": {
+        "flarum/core": "^1.2",
+        "clarkwinkelmann/flarum-ext-scout": "*",
+        "guzzlehttp/guzzle": "^7.0",
+        "ext-json": "*"
+    },
+    "authors": [
+        {
+            "name": "Clark Winkelmann",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "support": {
+        "source": "https://github.com/clarkwinkelmann/flarum-ext-meilisearch-dashboard"
+    },
+    "autoload": {
+        "psr-4": {
+            "ClarkWinkelmann\\MeilisearchDashboard\\": "src/"
+        }
+    },
+    "extra": {
+        "flarum-extension": {
+            "title": "Meilisearch Dashboard",
+            "category": "feature",
+            "icon": {
+                "name": "fas fa-search",
+                "backgroundColor": "#f47f68",
+                "color": "#fff"
+            }
+        }
+    }
+}

extend.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace ClarkWinkelmann\MeilisearchDashboard;
+
+use Flarum\Api\Serializer\ForumSerializer;
+use Flarum\Extend;
+
+return [
+    (new Extend\Frontend('admin'))
+        ->js(__DIR__ . '/js/dist/admin.js'),
+
+    new Extend\Locales(__DIR__ . '/locale'),
+
+    (new Extend\ApiSerializer(ForumSerializer::class))
+        ->attributes(ForumAttributes::class),
+
+    (new Extend\Middleware('forum'))
+        ->insertBefore('flarum.forum.route_resolver', MeilisearchDashboardMiddleware::class),
+];

js/admin.ts

@@ -0,0 +1 @@
+export * from './src/admin';

js/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "@clarkwinkelmann/meilisearch-dashboard",
+    "private": true,
+    "dependencies": {
+        "flarum-tsconfig": "^1.0",
+        "flarum-webpack-config": "^2.0",
+        "webpack": "^5.65",
+        "webpack-cli": "^4.9"
+    },
+    "scripts": {
+        "dev": "webpack --mode development --watch",
+        "build": "webpack --mode production"
+    }
+}

js/src/admin/index.ts

@@ -0,0 +1,29 @@
+import app from 'flarum/admin/app';
+import {extend} from 'flarum/common/extend';
+import SessionDropdown from 'flarum/admin/components/SessionDropdown';
+import LinkButton from 'flarum/common/components/LinkButton';
+import Separator from 'flarum/common/components/Separator';
+
+app.initializers.add('clarkwinkelmann-meilisearch-dashboard', () => {
+    app.extensionData.for('clarkwinkelmann-meilisearch-dashboard')
+        .registerPermission({
+            permission: 'meilisearch-dashboard.access',
+            label: app.translator.trans('clarkwinkelmann-meilisearch-dashboard.admin.permission.access'),
+            icon: 'fas fa-search',
+        }, 'moderate');
+
+
+    extend(SessionDropdown.prototype, 'items', function (items) {
+        items.add('meilisearch-dashboard', LinkButton.component({
+            icon: 'fas fa-search',
+            href: app.forum.attribute('baseUrl') + '/meilisearch/',
+            external: true,
+        }, app.translator.trans('clarkwinkelmann-meilisearch-dashboard.admin.header.link')));
+
+        // Add a separator between links and logout button, just like in the forum frontend
+        // Flamarkt Backoffice does the same thing
+        if (!items.has('separator')) {
+            items.add('separator', Separator.component(), -90);
+        }
+    });
+});

js/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "extends": "flarum-tsconfig",
+    "include": [
+        "src/**/*",
+        "../vendor/flarum/core/js/dist-typings/@types/**/*"
+    ],
+    "files": [],
+    "compilerOptions": {
+        "baseUrl": ".",
+        "paths": {
+            "flarum/*": [
+                "../vendor/flarum/core/js/dist-typings/*"
+            ]
+        }
+    }
+}

js/webpack.config.js

@@ -0,0 +1 @@
+module.exports = require('flarum-webpack-config')();