Hello World

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore

.gitignore

@@ -0,0 +1,8 @@
+docs/
+build/
+vendor/
+coverage/
+node_modules/
+resources/dist/app.js.LICENSE.txt
+resources/dist/mix-manifest.json
+composer.lock

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `filament-plausible-widget` will be documented in this file
+
+## 1.0.0 - 201X-XX-XX
+
+- initial release

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](/~https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Danilo Polani
+
+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,83 @@
+# Very short description of the package
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/danilopolani/filament-plausible-widget.svg?style=flat-square)](https://packagist.org/packages/danilopolani/filament-plausible-widget)
+[![Total Downloads](https://img.shields.io/packagist/dt/danilopolani/filament-plausible-widget.svg?style=flat-square)](https://packagist.org/packages/danilopolani/filament-plausible-widget)
+
+Add a fancy Plausible statistics widget to your Filament admin dashboard.
+
+<p align="center"><img src="https://i.imgur.com/TlBBVis.png" alt="Filament Plausible Widget preview"></p>
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require danilopolani/filament-plausible-widget
+```
+
+Then publish the config of the package and the assets as well:
+
+```bash
+php artisan vendor:publish --tag=filament-plausible-widget-config
+php artisan vendor:publish --tag=filament-plausible-widget-assets
+```
+
+### Upgrade
+When upgrading, you may want to republish the assets:
+
+```bash
+php artisan vendor:publish --tag=filament-plausible-widget-assets --force
+```
+
+## Configuration
+
+There are a few notable configuration options for the package.
+
+**`token`**
+
+Your Plausible API key. You can obtain an API key for your account by going to your user settings page https://plausible.io/settings.  
+
+**`site_id`**
+
+The site ID you want to get statistics of. You can obtain this value by navigating to your site settings in Plausible and grab the "value" of the domain field. E.g. `plausible.io/mysite.com` becomes `mysite.com`.  
+
+**`periods.default`** (Default: `7d`)
+
+The period shown by default in the dashboard. Can be any of these values: `day`, `7d`, `30d`, `month`, `6mo`, `12mo`.  
+
+**`periods.selectable`** (Default: `true`)
+
+Choose if let users select a different period of statistics in the dashboard.  
+
+**`cache.enabled`** (<u>**Recommended**</u>) (Default: `true`)
+
+Cache the statistics to avoid API calls for a specific amount of time.
+
+**`cache.ttl`**  
+
+If cache is enabled, define for how long the statistics are stored in the cache.
+
+## Known issues
+
+- Currently the `day` period does not work due a [Plausible bug](/~https://github.com/plausible/analytics/issues/797).
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, please email danilo.polani@gmail.com instead of using the issue tracker.
+
+## Credits
+
+- [Danilo Polani](/~https://github.com/danilopolani)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+## Laravel Package Boilerplate
+
+This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

composer.json

@@ -0,0 +1,58 @@
+{
+    "name": "danilopolani/filament-plausible-widget",
+    "description": "Plausible widget for Filament admin dashboard",
+    "keywords": [
+        "danilopolani",
+        "filament",
+        "filament-admin",
+        "plausible",
+        "filament-plausible-widget"
+    ],
+    "homepage": "/~https://github.com/danilopolani/filament-plausible-widget",
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Danilo Polani",
+            "email": "danilo.polani@gmail.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "filament/filament": "^1.6",
+        "illuminate/http": "^8.0",
+        "illuminate/support": "^8.0",
+        "livewire/livewire": "^2.4",
+        "spatie/laravel-package-tools": "^1.5"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^6.0",
+        "phpunit/phpunit": "^9.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Danilopolani\\FilamentPlausibleWidget\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Danilopolani\\FilamentPlausibleWidget\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Danilopolani\\FilamentPlausibleWidget\\FilamentPlausibleWidgetServiceProvider"
+            ]
+        }
+    }
+}

config/filament-plausible-widget.php

@@ -0,0 +1,90 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Plausible Token
+    |--------------------------------------------------------------------------
+    |
+    | API Token to access the APIs.
+    | You can obtain an API key for your account by going to your user settings
+    | page https://plausible.io/settings.
+    |
+    */
+
+    'token' => env('FILAMENT_PLAUSIBLE_TOKEN'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Plausible Site ID
+    |--------------------------------------------------------------------------
+    |
+    | Site ID you want to get stats of.
+    | You can obtain this value by navigating to your site settings in Plausible
+    | and grab the "value" of the domain field.
+    |
+    */
+
+    'site_id' => env('FILAMENT_PLAUSIBLE_SITE_ID'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Periods
+    |--------------------------------------------------------------------------
+    |
+    | Periods are the time spans of the statistics. You can configure how
+    | the user can (or cannot) interact with them and what's the default value.
+    |
+    */
+
+    'periods' => [
+        /*
+        |--------------------------------------------------------------------------
+        | Default period
+        |--------------------------------------------------------------------------
+        |
+        | Can be one of these values: day, 7d, 30d, month, 6mo, 12mo.
+        |
+        */
+        'default' => '7d',
+
+        /*
+        |--------------------------------------------------------------------------
+        | Default period
+        |--------------------------------------------------------------------------
+        |
+        | Define if the user can select a different period from the widget UI.
+        |
+        */
+        'selectable' => true,
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Cache
+    |--------------------------------------------------------------------------
+    |
+    | Configure how stats are cached.
+    |
+    */
+
+    'cache' => [
+        'enabled' => true,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Cache TTL
+        |--------------------------------------------------------------------------
+        |
+        | Configure for how long the statistics are cached.
+        | Valid units: millenium, century, decade, year, quarter, month, week,
+        | day, weekday, hour, minute, second, microsecond.
+        |
+        | You can use their alias as well, like "hour" => "h", "day" => "d".
+        |
+        */
+        'ttl' => '1h',
+    ],
+
+];