Installations
npm install @octokit-next/types-rest-api-ghec-compatibleDeveloper Guide
Typescript
Yes
Module System
ESM
Node Version
20.11.1
NPM Version
10.5.1
Score
64.8
Supply Chain
66.5
Quality
78.5
Maintenance
100
Vulnerability
99.6
License
Releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (79.48%)
TypeScript (20.52%)
Developer
octokit
Download Statistics
Total Downloads
696
Last Day
2
Last Week
14
Last Month
35
Last Year
210
GitHub Statistics
22 Stars
283 Commits
3 Forks
8 Watching
3 Branches
14 Contributors
Bundle Size
231.00 B
Minified
189.00 B
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
2.8.0
Package Id
@octokit-next/types-rest-api-ghec-compatible@2.8.0
Unpacked Size
2.81 kB
Size
1.27 kB
File Count
4
NPM Version
10.5.1
Node Version
20.11.1
Publised On
03 Apr 2024
Total Downloads
Cumulative downloads
Total Downloads
696
Last day
0%
2
Compared to previous day
Last week
133.3%
14
Compared to previous week
Last month
288.9%
35
Compared to previous month
Last year
-19.8%
210
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
@octokit-next/types-rest-api-ghec-compatible
Types for GHEC (compatible) REST API requests and responses
🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE
The goal for this package is to enable developers to build code that will work in both environments: github.com and GHEC. Only endpoints and properties that exist in both have types by default.
The version can be overwritten on a per-request basis as needed.
Usage
1const octokit = new Octokit({ 2 version: "ghec-compatible", 3}); 4const response = await octokit.request("GET /");
The routes suggested for octokit.request(route) are only the ones that exist for version: "github.com" and have no overrides for version: "ghec". The same is true for response.headers.
To override the version specified in the constructor it can be set using the request.version option
1const ghesOnlyResponse = await octokit.request("GET /admins/users", { 2 request: { 3 version: "ghec", 4 }, 5});
No vulnerabilities found.
Reason
13 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
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
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:14
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (30) are checked with a SAST tool
Reason
0 existing vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: SECURITY.md:1
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/add_to_octokit_project.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/codeql-analysis.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/immediate-response.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/openapi-update.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/openapi-update.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/openapi-update.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/openapi-update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/openapi-update.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/openapi-update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/openapi-update.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/openapi-update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/openapi-update.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/openapi-update.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/octokit-next.js/test.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release.yml:24
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
- Info: 2 out of 3 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29
- Warn: no topLevel permission defined: .github/workflows/add_to_octokit_project.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/openapi-update.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:8
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
Found 1/29 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
6.5
/10
Last Scanned on 2025-01-27
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