Repo Setup

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Changes
+
+<!-- A clear and detailed description of the changes that you have done -->
+
+<details>
+<summary>Screenshots</summary>
+<!-- 
+ Screenshots of the code running (if applicable)
+ Including these screenshots will assist the reviewing and speeding up the process
+-->
+
+</details>
+
+<details>
+<summary>Checkboxes</summary>
+
+- [x] I've added new features. (methods or parameters)
+- [ ] I've added jsdoc and typings.
+- [ ] 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`)
+
+</details>

.github/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported |
+| ------- | ------------------ |
+| 8.2.x | :white_check_mark: |
+| 9.x.x | :white_check_mark: |
+| 10.x.x | :white_check_mark: |
+| 11.x.x | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If a vulnerability is found within this project, as long as you follow the steps for responsible disclosure, there will
+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
+- @kathundd on Telegram

.github/workflows/ci-cd.yml

@@ -0,0 +1,55 @@
+name: 'CI/CD'
+on:
+ push:
+ paths:
+ - src/**
+ branches:
+ - master
+ workflow_dispatch:
+ pull-request:
+
+env:
+ NODE_VERSION: '20'
+
+jobs:
+ pnpm:
+ name: install dependencies (pnpm)
+ runs-on: ubuntu-latest
+ steps:
+ - name: Git checkout
+ uses: actions/checkout@v4
+
+ - name: Setup pnpm
+ uses: pnpm/action-setup@v2
+
+ - name: Use Node.js ${{ env.NODE_VERSION }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ env.NODE_VERSION }}
+ cache: 'pnpm'
+
+ - name: Install node dependencies
+ run: pnpm i
+
+ prettier:
+ name: check linting (prettier)
+ needs: [pnpm]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Git checkout
+ uses: actions/checkout@v4
+
+ - name: Setup pnpm
+ uses: pnpm/action-setup@v2
+
+ - name: Use Node.js ${{ env.NODE_VERSION }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ env.NODE_VERSION }}
+ cache: 'pnpm'
+
+ - name: Install node dependencies
+ run: pnpm i
+
+ - name: Check prettier
+ run: pnpm lint:prettier

.gitignore

@@ -1,2 +1,4 @@
 node_modules/
-oldreborn/
+oldreborn/
+.env
+build/

.npmignore

@@ -0,0 +1,4 @@
+node_modules/
+.git
+oldreborn/
+.github/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 StavZDev
+
+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

@@ -1 +1,6 @@
-# reborn-ts
+<div align="center">
+<img src="https://i.imgur.com/cDFoQZU.png?1">
+<h1>Hypixel API • Reborn</h1>
+</div>
+
+# This is very much a work in progress :fire:

package.json

@@ -1,23 +1,47 @@
 {
  "name": "reborn-ts",
- "version": "1.0.0",
- "description": "",
- "main": "index.js",
+ "version": "12.0.0",
+ "description": "Feature-rich Hypixel API wrapper for Node.js",
+ "main": "./src/index.ts",
+ "types": "./src/typings/index.d.ts",
+ "keywords": [
+ "minecraft",
+ "client",
+ "hypixel",
+ "api",
+ "hypixel-api",
+ "intellisense"
+ ],
+ "bugs": {
+ "url": "https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/issues"
+ },
  "scripts": {
- "prettier": "prettier --write .",
- "test": "echo \"Error: no test specified\" && exit 1"
+ "lint": "npx eslint --cache src/",
+ "lint:fix": "npx eslint --cache src/ --fix",
+ "prettier": "npx prettier --cache --write src/",
+ "prettier:check": "npx prettier --cache --check src/"
+ },
+ "engines": {
+ "node": ">=20",
+ "pnpm": ">=9.4",
+ "npm": "forbidden, use pnpm instead",
+ "yarn": "forbidden, use pnpm instead",
+ "bun": "forbidden, use pnpm instead"
  },
- "keywords": [],
- "author": "",
- "license": "ISC",
+ "author": "Kathund",
  "dependencies": {
- "@types/node-cron": "^3.0.11",
  "axios": "^1.7.2",
- "node-cache": "^5.1.2",
- "typescript": "^5.5.4"
+ "node-cache": "^5.1.2"
  },
+ "license": "MIT",
+ "readme": "https://github.com/Hypixel-API-Reborn/hypixel-api-reborn?tab=readme-ov-file#hypixel-api--reborn",
+ "repository": {
+ "url": "https://github.com/Hypixel-API-Reborn/hypixel-api-reborn"
+ },
+ "publisher": "Kathund",
  "devDependencies": {
  "@types/node": "^20.14.12",
- "prettier": "^3.3.3"
+ "prettier": "^3.3.3",
+ "typescript": "^5.5.4"
  }
 }