@zikeji/hypixel
Version:
With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible
296 lines (295 loc) • 8.15 kB
JSON
{
"name": "@zikeji/hypixel",
"version": "4.1.9",
"description": "With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible cache support, and helper functions.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"engines": {
"node": ">=20"
},
"private": false,
"publishConfig": {
"access": "public"
},
"scripts": {
"commit": "cz",
"lint": "eslint --ext ts src --fix",
"clean": "rimraf dist",
"build": "npm run clean && tsc -p .",
"types:openapi": "dtsgen --out ./src/types/api.ts --target ES2015 ./swagger.json && node ./scripts/process_api_output.js && eslint --ext ts ./src/types/api.ts --fix",
"watch": "npm run clean && tsc -p . -w",
"test": "npx -- mocha -r ts-node/register tests/**/*.test.ts",
"test:helpers": "npx -- mocha -r ts-node/register tests/helpers.test.ts",
"test:ci": "mocha -r ts-node/register tests/**/*.test.ts",
"test:lint": "eslint --ext ts src",
"coverage": "nyc npm t",
"coverage:ci": "nyc npm run test:ci",
"predocs:dev": "npm run build && typedoc",
"predocs:build": "npm run build && typedoc",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs",
"test:build": "npm run test:lint && npm run build && npm run test && npm run coverage"
},
"homepage": "https://node-hypixel.zikeji.com/",
"author": "Zikeji <me@zikeji.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/zikeji/node-hypixel/issues"
},
"repository": {
"url": "git@github.com:zikeji/node-hypixel.git"
},
"keywords": [
"api",
"api-wrapper",
"hypixel",
"skyblock",
"minecraft",
"hypixel skyblock",
"minecraft hypixel",
"hypixel minecraft",
"hypixel minecraft skyblock",
"hypixel api",
"skyblock api",
"minecraft api"
],
"files": [
"dist/",
"src/",
"!dist/**/*.map",
"!dist/tsconfig.tsbuildinfo",
"!docs/"
],
"release": {
"branches": [
"main"
],
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "conventionalcommits",
"releaseRules": [
{
"type": "docs",
"release": "patch"
},
{
"type": "refactor",
"release": "patch"
},
{
"type": "types",
"release": "patch"
},
{
"scope": "no-release",
"release": false
}
],
"presetConfig": {
"types": [
{
"type": "feat",
"section": "Features"
},
{
"type": "fix",
"section": "Bug Fixes"
},
{
"type": "types",
"section": "API Type Coverage"
},
{
"type": "docs",
"section": "Documentation"
},
{
"type": "style",
"hidden": true
},
{
"type": "refactor",
"section": "Code Refactoring"
},
{
"type": "perf",
"section": "Performance Improvements"
},
{
"type": "test",
"section": "Tests"
},
{
"type": "build",
"hidden": true
},
{
"type": "ci",
"hidden": true
},
{
"type": "chore",
"section": "Miscellaneous Chores"
},
{
"type": "revert",
"section": "Reverts"
}
]
}
}
],
[
"@semantic-release/release-notes-generator",
{
"preset": "conventionalcommits",
"presetConfig": {
"types": [
{
"type": "feat",
"section": "Features"
},
{
"type": "fix",
"section": "Bug Fixes"
},
{
"type": "types",
"section": "API Type Coverage"
},
{
"type": "docs",
"section": "Documentation"
},
{
"type": "style",
"hidden": true
},
{
"type": "refactor",
"section": "Code Refactoring"
},
{
"type": "perf",
"section": "Performance Improvements"
},
{
"type": "test",
"section": "Tests"
},
{
"type": "build",
"hidden": true
},
{
"type": "ci",
"hidden": true
},
{
"type": "chore",
"section": "Miscellaneous Chores"
},
{
"type": "revert",
"section": "Reverts"
}
]
}
}
],
[
"@semantic-release/changelog",
{
"changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file. See\n[Conventional Commits](https://conventionalcommits.org) for commit guidelines."
}
],
[
"@semantic-release/npm",
{
"npmPublish": true,
"tarballDir": "pack"
}
],
[
"@semantic-release/github",
{
"assignees": [
"zikeji"
],
"addReleases": "top",
"assets": [
{
"path": "CHANGELOG.md"
},
{
"path": "pack/*.tgz"
},
{
"path": "dist.zip",
"name": "dist-${nextRelease.gitTag}.zip"
}
]
}
],
[
"@semantic-release/git",
{
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
"assets": [
"CHANGELOG.md",
"package.json",
"package-lock.json"
]
}
]
]
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.2",
"@semantic-release/changelog": "^6.0.3",
"@semantic-release/git": "^10.0.1",
"@semantic-release/npm": "^13.1.4",
"@types/chai": "^5.2.3",
"@types/chai-as-promised": "^8.0.2",
"@types/debug": "^4.1.12",
"@types/mocha": "^10.0.10",
"@types/node": "^25.2.3",
"@typescript-eslint/eslint-plugin": "^8.55.0",
"@typescript-eslint/parser": "^8.55.0",
"chai": "^6.2.2",
"chai-as-promised": "^8.0.2",
"commitizen": "^4.3.1",
"conventional-changelog-conventionalcommits": "^9.1.0",
"cz-conventional-changelog": "^3.3.0",
"dtsgenerator": "^3.19.2",
"eslint": "^8.57.1",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-prettier": "^9.1.2",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-prettier": "^5.5.5",
"esm": "^3.2.25",
"mocha": "^11.7.5",
"nyc": "^17.1.0",
"prettier": "^3.8.1",
"prismarine-nbt": "^2.8.0",
"rimraf": "^6.1.3",
"semantic-release": "^25.0.3",
"ts-node": "^10.9.2",
"typedoc": "^0.28.17",
"typedoc-plugin-markdown": "^4.10.0",
"typedoc-vitepress-theme": "^1.1.2",
"typescript": "^5.6.2",
"vitepress": "^1.5.2"
},
"overrides": {
"typescript": "$typescript"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}