update

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,3 @@
+DOTENV_CONFIG_QUIET=true
+HYPIXEL_KEY=HYPIXEL_API_KEY
+HYPIXEL_URL=https://api.hypixel.net/v2

.github/CONTRIBUTING.md

@@ -2,9 +2,78 @@
 
 If you want to contribute to hypixel-api-reborn, feel free to fork the repository and submit pull request.
 
-## Setup
+## Table of contents
 
-1. Fork the repository.
-2. Run `npm ci`.
-3. Code your idea.
-4. Run `npm run eslint` to run ESlint.
+- [Requirements](#requirements)
+- [Project Setup](#project-setup)
+- [Testing your changes](#testing-your-changes)
+- [Submitting a pull request](#submitting-a-pull-request)
+- [Common issues](#common-issues)
+
+### Requirements
+
+- [Node v20.16.0 or higher](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
+- [pnpm v9.7.1 or higher](https://pnpm.io/installation)
+
+### Project Setup
+
+Once you have the requirements installed, you can clone the repository and install the dependencies.
+
+```bash
+pnpm install
+```
+
+Once you have all the packages installed, you will need to create a `.env` file. This file will contain the Hypixel API
+key. You can get one by going to the [Hypixel Developer Portal.](https://developer.hypixel.net/) This key will be used
+in the tests. Your `.env` file should look like this:
+
+```env
+HYPIXEL_KEY=HYPIXEL_API_KEY
+```
+
+**If your using vscode** With vscode we have a few recommended extensions that you can install to help with development.
+You will be promoted to install these when you open the project in vscode. If you don't see the prompt, you can install
+the extensions manually. Here are the recommended extensions:
+
+- [Editor Config](https://marketplace.visualstudio.com/items?itemName=editorconfig.editorconfig)
+- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+- [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
+- [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
+- [Vitest](https://marketplace.visualstudio.com/items?itemName=vitest.explorer)
+- [GitHub Pull Requests](https://marketplace.visualstudio.com/items?itemName=github.vscode-pull-request-github)
+
+### Testing your changes
+
+Before submitting a pull request, make sure to test your changes. You can run the tests with the following command:
+
+```bash
+pnpm test
+```
+
+### Submitting a pull request
+
+When submitting a pull request, make sure to provide a detailed description of the changes you made. If you are adding a
+new feature, make sure to include tests for it. If you are fixing a bug, make sure to include the bug report
+information. When making a pull request we have a few requirements:
+
+- Tests must pass (`pnpm test`)
+- Code must be linted (`pnpm eslint`)
+- Code must be formatted (`pnpm prettier`)
+- A clear and detailed description of the changes that you have done
+- Checkboxes for the changes you made
+- Screenshots of the code running (if applicable)
+
+### Common issues
+
+There are a few common issues that can come up when contributing to the project. Here are a few of them:
+
+- **Tests failing**: Tests will fail when making a pull request. This is because it's missing an API key set in github
+  actions. If this is the case, you can ignore the tests and someone will run them for you when reviewing the pull
+  request.
+
+- **Code formatting**: Code must be formatted and the github actions will check for this. If the code is not formatted,
+  the github action will fail and you will need to correct this before the pull request can be merged.
+
+- **Code using npm**: Any code that includes an npm lock file will not be accepted. This is because we use pnpm for
+  package management. If you have an npm lock file, you will need to remove it and use pnpm to install the packages.

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -5,5 +5,14 @@ about: Report a bug
 
 ### Bug report
 
-- Part of code where error occurred
-- What error occurred
+- Part of code where error occurred:
+- What error occurred:
+
+### Expected behavior
+
+- What you expected to happen:
+
+### Additional context
+
+- Node version:
+- Package version:

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,12 +14,11 @@
 <details>
 <summary>Checkboxes</summary>
 
-- [x] I've added new features. (methods or parameters)
-- [ ] I've added jsdoc and typings.
+- [ ] I've added new features. (methods or parameters)
 - [ ] I've fixed bug. (_optional_ you can mention a issue if there is one)
 - [ ] I've corrected the spelling in README, documentation, etc.
-- [ ] I've tested my code. (`npm run tests`)
-- [ ] I've check for issues. (`npm run eslint`)
-- [ ] I've fixed my formatting. (`npm run prettier`)
+- [ ] I've tested my code. (`pnpm test`)
+- [ ] I've check for issues. (`pnpm eslint`)
+- [ ] I've fixed my formatting. (`pnpm prettier`)
 
 </details>

.github/SECURITY.md

@@ -17,5 +17,5 @@ be no issue and the team will be greatful for your actions.
 To report a vulnerability you can do so in the [Discord Server](https://discord.gg/NSEBNMM) by openeing a support ticket
 or you can contact the primary contributor of this repository using the following contact methods:
 
-- @kathund. on Discord
+- @.kathund on Discord
 - @kathundd on Telegram

.github/labels.yml

@@ -0,0 +1,24 @@
+XS:
+  name: size/XS
+  lines: 0
+  color: 3CBF00
+S:
+  name: size/S
+  lines: 50
+  color: 5D9801
+M:
+  name: size/M
+  lines: 200
+  color: 7F7203
+L:
+  name: size/L
+  lines: 1000
+  color: A14C05
+XL:
+  name: size/XL
+  lines: 3000
+  color: C32607
+XXL:
+  name: size/XXL
+  lines: 7500
+  color: E50009

.github/renovate.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended", "group:allNonMajor"],
+  "rebaseWhen": "behind-base-branch",
+  "ignoreDeps": ["pnpm", "node", "@types/node", "typedoc", "hypixel-api-reborn", "skyhelper-networth"],
+  "semanticCommits": "enabled",
+  "labels": ["dependencies"],
+  "schedule": ["* 0 * * *"],
+  "enabledManagers": ["npm"],
+  "rangeStrategy": "bump",
+  "prConcurrentLimit": 5,
+  "forkProcessing": "enabled",
+  "prHourlyLimit": 0,
+  "timezone": "UTC",
+  "packageRules": [
+    { "matchUpdateTypes": ["minor", "patch"], "matchCurrentVersion": "!/^0/", "commitMessagePrefix": "chore(deps):" }
+  ]
+}

.github/scripts/Utils.ts

@@ -0,0 +1,29 @@
+import { readdir } from 'fs/promises';
+
+export interface ScanDirectoryOptions {
+  goDeep?: boolean;
+  replaceSrc?: boolean;
+}
+
+export async function scanDirectory(directoryPath: string, options?: ScanDirectoryOptions): Promise<string[]> {
+  const parsedOptions: ScanDirectoryOptions = {
+    goDeep: options?.goDeep ?? true,
+    replaceSrc: options?.replaceSrc ?? false
+  };
+  const filePaths: string[] = [];
+  const files = await readdir(directoryPath, { withFileTypes: true });
+
+  for (const file of files) {
+    const fullPath = directoryPath + file.name;
+    if (file.isDirectory() && parsedOptions.goDeep) {
+      const paths = await scanDirectory(`${fullPath}/`, parsedOptions);
+      paths.forEach((path) => filePaths.push(path));
+    } else {
+      if (fullPath.endsWith('.test.ts')) continue;
+      if (fullPath.endsWith('index.ts')) continue;
+      filePaths.push(fullPath.replaceAll('./src/', parsedOptions.replaceSrc ? './' : './src/'));
+    }
+  }
+
+  return filePaths;
+}

.github/scripts/checkCoverage.ts

@@ -0,0 +1,41 @@
+import { parseStringPromise } from 'xml2js';
+import { readFileSync } from 'fs';
+
+const coverageDataFile = readFileSync('./coverage/clover.xml', 'utf-8');
+const parsed = await parseStringPromise(coverageDataFile);
+
+const codeStats = parsed.coverage.project[0].metrics[0].$;
+const info = {
+  statements: Number(codeStats.statements),
+  coveredStatements: Number(codeStats.coveredstatements),
+  conditionals: Number(codeStats.conditionals),
+  coveredConditionals: Number(codeStats.coveredconditionals),
+  methods: Number(codeStats.methods),
+  coveredMethods: Number(codeStats.coveredmethods)
+};
+
+const baseline = 95;
+
+const statementsCoverage = (info.coveredStatements / info.statements) * 100;
+if (statementsCoverage <= baseline) {
+  throw new Error(`Statements is required to be ${baseline}% or higher. Currently ${statementsCoverage.toFixed(2)}`);
+}
+
+const conditionalsCoverage = (info.coveredConditionals / info.conditionals) * 100;
+if (conditionalsCoverage <= baseline) {
+  throw new Error(
+    `Conditionals is required to be ${baseline}% or higher. Currently ${conditionalsCoverage.toFixed(2)}`
+  );
+}
+
+const methodsCoverage = (info.coveredMethods / info.methods) * 100;
+if (methodsCoverage <= baseline) {
+  throw new Error(`Methods is required to be ${baseline}% or higher. Currently ${methodsCoverage.toFixed(2)}`);
+}
+
+const combinedCoverage = statementsCoverage + conditionalsCoverage + methodsCoverage;
+if (combinedCoverage <= baseline) {
+  throw new Error(
+    `Everything Combined is required to be ${baseline}% or higher. Currently ${combinedCoverage.toFixed(2)}`
+  );
+}

.github/scripts/generateAPIIndexFile.ts

@@ -0,0 +1,32 @@
+import { format } from 'prettier';
+import { readFileSync, writeFileSync } from 'fs';
+import { scanDirectory } from './Utils';
+
+const prettierConfig = JSON.parse(readFileSync('.prettierrc').toString('utf-8'));
+
+(async () => {
+  const lines: string[] = ['/* v8 ignore next 10000 */', ''];
+
+  const importNames: string[] = [];
+
+  const apiPaths = await scanDirectory('./src/API/', { goDeep: false, replaceSrc: true });
+  const fixedAPIPaths: string[] = [];
+
+  apiPaths.forEach((path) => {
+    const importName = path.split('.ts')[0].split('/')[path.split('.ts')[0].split('/').length - 1];
+    importNames.push(importName);
+    const fixedPath = path.replaceAll('.ts', '.js').replaceAll('./API/', './');
+    fixedAPIPaths.push(`import ${importName} from '${fixedPath}';`);
+  });
+
+  fixedAPIPaths.sort().forEach((path) => lines.push(path));
+
+  lines.push('');
+  lines.push('export default {');
+  importNames.sort().forEach((importName) => lines.push(`${importName},`));
+  lines.push('};');
+  lines.push('');
+
+  const formatted = await format(lines.join('\n'), { ...prettierConfig, filepath: './src/API/index.ts' });
+  writeFileSync('./src/API/index.ts', formatted);
+})();