# yabsl

> Yet another Beat Saber library. A wrapper for all major Beat Saber services.

Latest version **1.1.1** (published 2023-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install yabsl
pnpm add yabsl
yarn add yabsl
bun add yabsl
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-11-01 |
| First published | 2023-10-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 264 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | stormpacer |
| Maintainers | stormpacer |
| Keywords | Beatsaver, Scoresaber, Beatleader, Hitbloq, Accsaber |

## Links

- npm: https://www.npmjs.com/package/yabsl
- Repository: https://github.com/StormPacer/yabsl
- Homepage: https://github.com/StormPacer/yabsl#readme
- Issues: https://github.com/StormPacer/yabsl/issues
- npm.io page: https://npm.io/package/yabsl

## Recent versions

- 1.1.1 (latest) — 2023-11-01
- 1.1.0 — 2023-10-31
- 1.0.2 — 2023-10-22
- 1.0.1 — 2023-10-22
- 1.0.0 — 2023-10-22

## README

# yabsl
Yet another Beat Saber library. A wrapper for all major Beat Saber services.


## Installation

```bash
npm i yabsl
# or
yarn add yabsl
```

## Usage

### CommonJS import
```js
const yabsl = require('yabsl');

const beatsaver = yabsl.BeatSaver
```

**OR**

```js
const { BeatSaver } = require('yabsl');
```

### ES6 import

```js
import yabsl from 'yabsl';

const beatsaver = yabsl.BeatSaver
```

**OR**

```js
import { BeatSaver } from 'yabsl';
```

## Using the wrapper

```js
import { BeatSaver } from 'yabsl';

async function someFunction() {
    const maps = await BeatSaver.maps.search("Latest", "Camellia", 0, {
        verified: true
    });

    // Returns an array of maps fitting the search criteria
}
```

The library is fully typed so all of the objects and functions will display what they need/have.

**Yabsl is compatible with both JavaScript and TypeScript**

## Roadmap

- [x] BeatLeader support
- [ ] Full AccSaber support

## All yabsl functions

### BeatSaver

#### Usable functions

**Maps:**
- `id` - Get a map by it's id
- `hash` - Get a map by it's hash
- `multiple` - Get multiple maps by id (eg. ['1', '2', '3'])
- `uploader` - Get maps by uploader
- `collaborations` - Get maps by uploader including collaborations
- `latest` - Get the latest maps
- `search` - Search for the maps, more options explained later.

**Playlists:**
- `id` - Get a playlist by id
- `user` - Get playlists made by a user
- `latest` - Get the latest playlists
- `search` - Search for the playlists, more options explained later.

**Users:**
- `id` - Get a user by their id
- `name` - Get a user by their name

**Votes:**
- `get` - Get all the votes from a specific date onward

#### Options

**ALL OPTIONS ARE OPTIONAL!!!**

Map search options:

| Option | Type |
| ------ | ---- |
| automapper | boolean |
| chroma | boolean |
| cinema | boolean |
| curated | boolean |
| from | string (date) |
| fullSpread | boolean |
| maxBpm | number |
| maxDuration | number |
| maxNps | number |
| maxRating | number |
| minBpm | number |
| minDuration | number |
| minNps | number |
| minRating | number |
| noodle | boolean |
| tags | string[] |
| to | string (date) |
| verified | boolean |

Playlist search options:

| Option | Type |
| ------ | ---- |
| curated | boolean |
| from | string (date) |
| includeEmpty | boolean |
| maxNps | number |
| minNps | number |
| to | string (date) |
| verified | boolean |

### BeatLeader

#### Usable functions

**Leaderboards:**
- `id` - Get a leaderboard by it's id, more options explained later
- `clanRanking` - Get the clean ranking on a leaderboard
- `clanRankingGlobal` - Get the clan ranking on all leaderboards
- `hash` - Get the leaderboard by hash
- `get` - Get leaderboards by your query options, more options explained later
- `getGruoped` - Same as above but grouped
- `ranking` - Get the ranking of a certain map
- `statistic` - Get the statistics of a certain leaderboard

**Players:**
- `id` - Get the player by their id
- `discord` - Get the player by their discord id
- `beatsaver` - Get the player by their beatsaver id
- `get` - Get multiple players by your query, more options explained later
- `event` - Get the event by it's id, more options explained later

**Scores:**
- `get` - Get the scores of a player, more options explained later
- `getCompact` - Get the scores of a player but it's compact now, same options as `get`
- `getValue` - Get the score value of a player on a certain map
- `histogram` - Get the histogram of a player, options the same as `get` with the added `batch` property
- `accGraph` - Get the accuracy graph of a player
- `history` - Get the history of a player
- `getPinnedScores` - Get the pinned scores of a player

**Clans:**
- `get` - Get the clans according to your query, more options explained later
- `tag` - Get the clan according to your tag, more options explained later

**Playlists:**
- `get` - Get all the playlists
- `id` - Get the playlist data according to it's id
- `image` - Get the playlist image as a buffer or download it

**Events:**
- `get` - Get the events according to your query, more options explained later
- `id` - Get an event by it's id

#### Options

**ALL OPTIONS ARE OPTIONAL!!!**

Leaderboards id options:

| Option | Type |
| ------ | ---- |
| page | number |
| count | number |
| sortBy | string |
| order | number |
| scoreStatus | number |
| leaderboardContext | number |
| countries | string |
| search | string |
| modifiers | string |

Leaderboard get and getGroupped options:

| Option | Type |
| ------ | ---- |
| page | number |
| count | number |
| sortBy | number |
| order | number |
| search | string |
| type | number |
| mode | string |
| mapType | number |
| allTypes | number |
| mapRequirements | number |
| allRequirements | number |
| myType | number |
| stars_from | string |
| stars_to | string |
| accrating_from | number |
| accrating_to | number |
| passrating_from | number |
| passrating_to | number |
| techrating_from | number |
| techrating_to | number |
| date_from | number |
| date_to | number |

Players get options:

| Option | Type |
| ------ | ---- |
| sortBy | string |
| page | number |
| count | number |
| search | string |
| order | number |
| countries | string |
| mapTypes | string |
| ppType | string |
| leaderboardContext | number |
| pp_range | string |
| score_range | string |
| platform | string |
| role | string |
| hmd | string |
| clans | string |
| activityPeriod | number |
| banned | boolean |

Player events options:

| Option | Type |
| ------ | ---- |
| sortBy | string |
| page | number |
| count | number |
| search | string |
| order | number |
| countries | string |

Scores get options:

| Option | Type |
| ------ | ---- |
| sortBy | string |
| order | number |
| page | number |
| count | number |
| search | string |
| diff | string |
| mode | string |
| requirements | number |
| scoreStatus | number |
| leaderboardContext | number |
| type | string |
| modifiers | string |
| stars_from | number |
| stars_to | number |
| time_from | number |
| time_to | number |
| eventId | number |

Clans get options:

| Option | Type |
| ------ | ---- |
| page | number |
| count | number |
| search | string |
| sort | string |
| order | number |
| type | string |
| sortBy | string |

Clan tag options:

| Option | Type |
| ------ | ---- |
| page | number |
| count | number |
| search | string |
| sort | string |
| order | number |
| capturedLeaderboards | string |

Events get options:

| Option | Type |
| ------ | ---- |
| page | number |
| count | number |
| sortBy | string |
| search | string |
| order | number |

### ScoreSaber

#### Usable functions

**Leaderboards:**
- `get` - Get leaderboards by a text query, more options explained later
- `id` - Get a leaderboard by it's id
- `infoByHash` - Get a leaderboard by a song's hash and difficulty
- `scoresById` - Get the scores on a leaderboard by it's id
- `scoresByHash` - Get the scores by the songs's hash and difficulty, more options explained later
- `getDifficulties` - Get the difficulties of a map by it's hash

**Players:**
- `get` - Get the players by querying their name
- `count` - Returns the amount of players by your query
- `basic` - Get the basic info of a player with their ID
- `full` - Get the full info of a player with their ID
- `scores` - Get the player's scores by their id

**Rankings:**
- `id` - Get a ranking request by it's ID
- `leaderboardId` - Get a ranking request by it's leaderboard ID

#### Options

**ALL OPTIONS ARE OPTIONAL!!!**

Leadearboards get options:

| Option | Type |
| ------ | ---- |
| ranked | boolean |
| qualified | boolean |
| loved | boolean |
| minStar | number |
| maxStar | number |
| category | number |
| sort | number |
| unique | boolean |
| withMetadata | boolean |

Scores by hash options:

| Option | Type |
| ------ | ---- |
| countries | string[] |
| search | string |
| withMetadata | boolean |

### Hitbloq

#### Usable functions

**Ladders:**
- `get` - Get the ladder for a certain pool ID
- `near` - Get the players near the player of the pool ID

**Pools:**
- `get` - Get the pool names
- `detailed` - Get the pools but with more information
- `popular` - Get the names of all the popular pools 

**Ranked:**
- `id` - Get the pool information + the first 30 ranked maps
- `maps` - Get the ranked maps from a pool

**Users:**
- `scores` - Get a few scores from a user on a certain pool
- `allScores` - Get all the scores from a user on a certain pool
- `badges` - Get the list of badges that a user has

### AccSaber

**Leaderboards:**
- `overallAcc` - Get all the players on the leaderboard for overall accuracy
- `techAcc` - Get all the players on the leaderboard for tech accuracy
- `trueAcc` - Get all the players on the leaderboard for true accuracy
- `standardAcc` - Get all the players on the leaderboard for standard accuracy

**Players:**
- `get` - Get all the players on AccSaber
- `id` - Get a certain player and choose which category to look up their stats for

**Maps:**
- `get` - Get all ranked maps
- `id` - Get the map with a certain leaderboard id
- `category` - Get all ranked maps of a certain category
- `playlist` - Get or download a playlist of all ranked maps

---
_Source: https://npm.io/package/yabsl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._