Installations
npm install @pkmn/smogonReleases
Unable to fetch releases
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
22.6.0
NPM Version
10.8.3
Statistics
28 Stars
1,801 Commits
4 Forks
6 Watching
2 Branches
4 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (54.47%)
JavaScript (45.53%)
Total Downloads
Cumulative downloads
Total Downloads
14,761
Last day
1.2%
84
Compared to previous day
Last week
6.2%
705
Compared to previous week
Last month
1.7%
2,704
Compared to previous month
Last year
119%
8,479
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
1
@pkmn's unofficial APIs for Smogon's analysis,
moveset, sample teams, and usage statistics data.
Smogon does not officially provide any API for third party developers, and is at liberty to make breaking changes to its internal data representations at any point - this project attempts to provide a stable way of accessing the data Smogon exposes on its site. Two packages are provided:
smogon: A low-level wrapper around Smogon's analysis and statistics endpoints used to ergonomically fetch raw data via point queries from the source.@pkmn/smogon: A rich client for the processed and aggregated Smogon analysis and moveset information available at data.pkmn.cc.
data.pkmn.cc contains several curated datasets pulled
from Smogon and Pokémon Showdown which have been processed to allow for
efficient batch access of analysis, sets, teams, and statistics data by format
or generation. Analysis and set data is refreshed
automatically every 24
hours
as are sample teams, the best stats data for each generation is converted each
month into @pkmn/stats's optimized output
format, and
information about Pokémon Showdown’s standard Random Battle formats from
pkmn/randbats is updated hourly.
The API for these endpoints is documented though
subject to change - developers relying on these endpoints should join the
Discord to keep abreast of updates and/or rely on the latest version of the
@pkmn/smogon package to simplify the data handling.
While this project's code is distributed under the terms of the MIT License and the aggregated stats information is freely available in the public domain, the set and analysis data is copyrighted by Smogon and its contributors.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/pkmn/.github/SECURITY.md:1
- Info: Found linked content: github.com/pkmn/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/pkmn/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/pkmn/.github/SECURITY.md:1
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Warn: no topLevel permission defined: .github/workflows/update-formats.yml:1
- Warn: no topLevel permission defined: .github/workflows/update-imgs.yml:1
- Warn: no topLevel permission defined: .github/workflows/update-sets.yml:1
- Warn: no topLevel permission defined: .github/workflows/update-stats.yml:1
- Warn: no topLevel permission defined: .github/workflows/update-teams.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-formats.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/update-formats.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-imgs.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/update-imgs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-sets.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/update-sets.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-stats.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/update-stats.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-teams.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pkmn/smogon/update-teams.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:17
- Warn: npmCommand not pinned by hash: .github/workflows/update-formats.yml:16
- Warn: npmCommand not pinned by hash: .github/workflows/update-imgs.yml:16
- Warn: npmCommand not pinned by hash: .github/workflows/update-sets.yml:16
- Warn: npmCommand not pinned by hash: .github/workflows/update-stats.yml:16
- Warn: npmCommand not pinned by hash: .github/workflows/update-teams.yml:16
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 npmCommand dependencies pinned
Score
5
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More