Merge branch main into 95-automatic-invoice-notifications

Author: zefir-git

.github/dependabot.yml

@@ -4,3 +4,5 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+      day: "monday"
+      time: "06:00"

.github/workflows/codeql.yml

@@ -14,9 +14,17 @@ name: "CodeQL"
 on:
   push:
     branches: [ "master" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.yml'
+      - '**/*.xml'
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ "master" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.yml'
+      - '**/*.xml'
   schedule:
     - cron: '40 22 * * 2'
 
@@ -51,7 +59,7 @@ jobs:
 
     - uses: actions/setup-java@v3
       with:
-        distribution: 'corretto'
+        distribution: 'temurin'
         java-version: 17
 
     # Initializes the CodeQL tools for scanning.

.github/workflows/maven.yml

@@ -8,6 +8,9 @@
 
 name: Java CI with Maven
 
+permissions:
+  contents: write
+
 on:
   push:
     branches: [ "master" ]

README.md

@@ -1,33 +1,81 @@
-[![Banner](https://i.ibb.co/2yFTQ8X/banner-optimised.png)](https://modrinth.com/plugin/Dc8RS2En/)
-
 # Bank Accounts
-[![Available on Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/Dc8RS2En)
-[![Available for Paper](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/supported/paper_vector.svg)](https://papermc.io/software/paper)
-[![Available on GitHub](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/github_vector.svg)](https://github.com/cloudnode-pro/BankAccounts/)
+[![Available on Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/Dc8RS2En) [![Available for Paper](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/supported/paper_vector.svg)](https://papermc.io/software/paper) [![Available on GitHub](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/github_vector.svg)](https://github.com/cloudnode-pro/BankAccounts/)
+
+[![Java CI with Maven](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/maven.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/maven.yml) [![CodeQL](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml) [![Version](https://img.shields.io/modrinth/v/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/version/latest) [![Game Versions](https://img.shields.io/modrinth/game-versions/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/) [![Downloads](https://img.shields.io/modrinth/dt/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
+
+A Minecraft economy plugin that enables players to hold multiple bank accounts.
+
+[**`Download`**](https://modrinth.com/plugin/Dc8RS2En/version/latest)
+
+## Features
+
+See also: [Commands](https://github.com/cloudnode-pro/BankAccounts/wiki/Commands) · [Permissions](https://github.com/cloudnode-pro/BankAccounts/wiki/Permissions)
+
+### Multiple Accounts/Balances
+Players can have multiple independent bank accounts. You can have both personal and business accounts.
+
+### Transaction History
+See the history of your account’s transactions using the `/bank history` command.
+
+### Payment Requests (Invoices)
+Request money from players and track the payment status.
+
+### Vault Support
+
+If [Vault](https://github.com/MilkBowl/Vault/releases/latest) is installed on your server,
+you can [enable its integration in the configuration](https://github.com/cloudnode-pro/BankAccounts/blob/dad253525b6bc3ee9647cd01c75e2c425a921f58/src/main/resources/config.yml#L38-L44).
+This allows BankAccounts to function as a Vault economy provider,
+enabling compatibility with third-party plugins that support Vault.
+
+### POS and Bank Cards
+
+You can create a [Point of Sale](https://github.com/cloudnode-pro/BankAccounts/wiki/POS), which is a type of single-use chest shop. Players can pay using a bank card (`/bank card`).
 
-[![CodeQL](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml)
-[![Version](https://img.shields.io/modrinth/v/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
-[![Game Versions](https://img.shields.io/modrinth/game-versions/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
-[![Downloads](https://img.shields.io/modrinth/dt/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
+### Extensive Configuration
 
-A multi-account economy plugin.
+All functionality is fully configurable. See [default config](https://github.com/cloudnode-pro/BankAccounts/blob/master/src/main/resources/config.yml).
 
-[**`Features (Wiki)`**](https://github.com/cloudnode-pro/BankAccounts/wiki)
-· [**`Commands`**](https://github.com/cloudnode-pro/BankAccounts/wiki/Commands)
-· [**`Permissions`**](https://github.com/cloudnode-pro/BankAccounts/wiki/Permissions)
-· [**`Download`**](https://modrinth.com/plugin/Dc8RS2En/version/latest)
+## Support
+
+| Matrix | [bankaccounts:cloudnode.pro](https://matrix.to/#/#bankaccounts:cloudnode.pro) |
+|--------|-------------------------------------------------------------------------------|
+
+Join our dedicated BankAccounts community space on Matrix to engage in discussions, receive support, and stay updated on crucial plugin announcements.
+
+If you want to report a problem or request a feature, please [submit a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug).
+
+## Release Cycle
+
+BankAccounts follows a weekly **time-based release schedule**, with new features or changes typically released every **Tuesday**.
+
+When we merge critical bug fixes, we may publish out-of-band releases on any day of the week.
 
 ## Report Issues
-If you discover any issues with the plugin, please first check the [known issues](https://github.com/cloudnode-pro/BankAccounts/issues?q=is%3Aopen+is%3Aissue+label%3Abug). If it is not listed there, please [create a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug). Fixing bugs is the highest priority for this project.
+Please ensure that you are using the [latest version](https://modrinth.com/plugin/Dc8RS2En/version/latest) of BankAccounts. The newest bug fixes are only available in the most recent version, and support is provided exclusively for this version.
 
-When reporting an issue, please include as much relevant information as possible, including error logs, screenshots, and steps to reproduce the issue.
+If you encounter any problems with the plugin, please first check the [list of known issues](https://github.com/cloudnode-pro/BankAccounts/issues?q=is%3Aopen+is%3Aissue+label%3Abug) on our GitHub repository. If you don’t find a similar fault listed there, we encourage you to [submit a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug). Resolving bugs is the highest priority for this project.
 
-Please make sure you are using the latest version of BankAccounts.
+To help us resolve your issue as quickly as possible, please provide as much relevant information as possible, including error logs, screenshots, and detailed steps to reproduce the problem.
 
-## Request Features
-If you would like to request a new feature, please [open a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new) and describe what you have in mind.
+## Feature Requests
 
-Due to each player having multiple accounts, it is difficult to integrate this project with other plugins. BankAccounts provides replacements for some such functionalities.
+To suggest a new feature, please [create a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new), providing a detailed description of your idea.
 
 ## Contributing
-If you would like to contribute to the project, you can [fork the repository](https://github.com/cloudnode-pro/BankAccounts/fork) and create a pull request.
+
+New contributors are most welcome to the project.
+
+If you're interested in contributing, follow these steps:
+
+1.  [Fork the repository](https://github.com/cloudnode-pro/BankAccounts/fork)
+2.  Create a new branch for your contributions.
+3.  Make your changes and ensure they align with the project’s goals.
+4.  Commit your changes with clear and descriptive messages.
+5.  Push your changes to your fork.
+6.  Submit a pull request.
+
+## Thanks To
+
+[<img src="https://github.com/JetBrains/logos/raw/master/web/jetbrains/jetbrains-simple.svg" alt="JetBrains logo." height="96">](https://www.jetbrains.com)
+
+[JetBrains](https://www.jetbrains.com/), creators of the IntelliJ IDEA, supports BankAccounts with one of their [Open Source Licenses](https://www.jetbrains.com/opensource/). IntelliJ IDEA is the recommended IDE for working with BankAccounts.

pom.xml

@@ -21,7 +21,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.12.1</version>
+                <version>3.13.0</version>
                 <configuration>
                     <source>${java.version}</source>
                     <target>${java.version}</target>
@@ -30,7 +30,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>3.5.1</version>
+                <version>3.6.0</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -65,6 +65,10 @@
             <id>placeholderapi</id>
             <url>https://repo.extendedclip.com/content/repositories/placeholderapi/</url>
         </repository>
+        <repository>
+            <id>jitpack.io</id>
+            <url>https://jitpack.io</url>
+        </repository>
     </repositories>
 
     <dependencies>
@@ -78,16 +82,24 @@
             <groupId>com.zaxxer</groupId>
             <artifactId>HikariCP</artifactId>
             <version>5.1.0</version>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.mariadb.jdbc</groupId>
             <artifactId>mariadb-java-client</artifactId>
-            <version>3.3.2</version>
+            <version>3.4.1</version>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>me.clip</groupId>
             <artifactId>placeholderapi</artifactId>
-            <version>2.11.5</version>
+            <version>2.11.6</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.github.MilkBowl</groupId>
+            <artifactId>VaultAPI</artifactId>
+            <version>1.7.1</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>

src/main/java/pro/cloudnode/smp/bankaccounts/Account.java

@@ -10,6 +10,7 @@
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.persistence.PersistentDataType;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 import javax.annotation.Nullable;
@@ -106,7 +107,7 @@ public Account(final @NotNull ResultSet rs) throws @NotNull SQLException {
     }
 
     public final @NotNull String name() {
-        return this.name == null ? (this.type == Type.PERSONAL && this.owner.getName() != null ? this.owner.getName() : this.id) : this.name;
+        return this.name == null ? (this.type == Type.VAULT && this.owner.getName() != null ? this.owner.getName() : this.id) : this.name;
     }
 
     public final @NotNull Component ownerName() {
@@ -194,8 +195,19 @@ public static boolean isInstrument(final @NotNull ItemStack item) {
     /**
      * Get account by ID
      * @param id Account ID
+     * @deprecated Use {@link #get(Account.Tag)}
      */
+    @Deprecated
     public static @NotNull Optional<@NotNull Account> get(final @NotNull String id) {
+        return getByID(id);
+    }
+
+    /**
+     * Get account by ID
+     * @param id Account ID
+     */
+    @ApiStatus.Internal
+    private static @NotNull Optional<@NotNull Account> getByID(final @NotNull String id) {
         try (final @NotNull Connection conn = BankAccounts.getInstance().getDb().getConnection();
              final @NotNull PreparedStatement stmt = conn.prepareStatement("SELECT * FROM `bank_accounts` WHERE `id` = ? LIMIT 1")) {
             stmt.setString(1, id);
@@ -208,6 +220,19 @@ public static boolean isInstrument(final @NotNull ItemStack item) {
         }
     }
 
+    /**
+     * Get account by tag
+     */
+    public static @NotNull Optional<@NotNull Account> get(final @NotNull Account.Tag tag) {
+        return switch (tag.type) {
+            case ID -> get(tag.value);
+            case USERNAME -> {
+                final @NotNull OfflinePlayer player = BankAccounts.getInstance().getServer().getOfflinePlayer(tag.value);
+                yield getVaultAccount(player);
+            }
+        };
+    }
+
     /**
      * Get account from instrument
      * @param instrument Instrument item
@@ -267,6 +292,15 @@ public static boolean isInstrument(final @NotNull ItemStack item) {
         }
     }
 
+    /**
+     * Get the Vault account of a player
+     */
+    public static @NotNull Optional<@NotNull Account> getVaultAccount(final @NotNull OfflinePlayer player) {
+        final @NotNull Account @NotNull [] accounts = get(player, Type.VAULT);
+        if (accounts.length == 0) return Optional.empty();
+        return Optional.of(accounts[0]);
+    }
+
     /**
      * Get accounts sorted by balance
      *
@@ -307,7 +341,6 @@ else if (limit != null) {
      * Get the server account
      */
     public static @NotNull Optional<@NotNull Account> getServerAccount() {
-        if (!BankAccounts.getInstance().config().serverAccountEnabled()) return Optional.empty();
         final @NotNull Account @NotNull [] accounts = get(BankAccounts.getConsoleOfflinePlayer());
         if (accounts.length == 0) return Optional.empty();
         return Optional.of(accounts[0]);
@@ -377,7 +410,11 @@ public enum Type {
         /**
          * Account owned by a company or other corporate entity
          */
-        BUSINESS;
+        BUSINESS,
+        /**
+         * Vault integration account
+         */
+        VAULT;
 
         /**
          * Get type name (as set in config)
@@ -428,4 +465,55 @@ public void update() {}
         @Override
         public void delete() {}
     }
+
+    /**
+     * An account tag is a unique pointer to a specific account.
+     */
+    public record Tag(@NotNull Account.Tag.Type type, @NotNull String value) {
+        /**
+         * Create a new account ID tag
+         * @param id Account ID
+         */
+        public static @NotNull Tag id(final @NotNull String id) {
+            return new Tag(Account.Tag.Type.ID, id);
+        }
+
+        /**
+         * Create a new Vault account tag by username
+         * @param username Username of Vault account holder
+         */
+        public static @NotNull Tag username(final @NotNull String username) {
+            return new Tag(Account.Tag.Type.USERNAME, username);
+        }
+
+        /**
+         * Create account tag from string
+         * @param string Use {@code @} prefix for Vault account owner username.
+         */
+        public static @NotNull Tag from(final @NotNull String string) {
+            if (string.startsWith("@")) return username(string.substring(1));
+            return id(string);
+        }
+
+        /**
+         * Get the account that this tag points to
+         */
+        public @NotNull Optional<@NotNull Account> get() {
+            return Account.get(this);
+        }
+
+        /**
+         * Account tag type
+         */
+        public enum Type {
+            /**
+             * Account by ID
+             */
+            ID,
+            /**
+             * Vault account by username
+             */
+            USERNAME
+        }
+    }
 }