npmpackage.info

Gathering detailed insights and metrics for @octokit-next/request

Other packages similar to @octokit-next/request

@octokit/plugin-request-log

5.3.1

Log all requests and request errors

@octokit/request

9.1.3

Send parameterized requests to GitHub's APIs with sensible defaults in browsers and Node

@octokit/request-error

6.1.5

Error class for Octokit request errors

@octokit/endpoint

10.1.1

Turns REST API endpoints into generic request options

Gathering detailed insights and metrics for @octokit-next/request

@octokit-next/request

2.8.0

MIT

JavaScript

300,812 6.4

Installations

npm install @octokit-next/request

Pull Requests

Open

2

Total

212

Closed

4

Merged

206

Issues

Open

5

Total

36

Closed

31

Releases

v2.8.0

Published on 03 Apr 2024

v2.7.1

Published on 17 Jul 2023

v2.7.0

Published on 22 Dec 2022

v2.6.1

Published on 21 Dec 2022

v2.6.0

Published on 13 Oct 2022

v2.5.2

Published on 11 Oct 2022

View all 50 releases

Developer

octokit

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

20.11.1

NPM Version

10.5.1 Statistics

22 Stars

274 Commits

3 Forks

8 Watching

3 Branches

14 Contributors

Updated on 26 Nov 2024

Languages

JavaScript (79.5%)

TypeScript (20.5%)

Total Downloads

Cumulative downloads

Total Downloads

300,812

Last day

-44.8%

128

Compared to previous day

Last week

72.6%

2,849

Compared to previous week

Last month

14.8%

7,190

Compared to previous month

Last year

-33.9%

96,106

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@octokit-next/endpoint @octokit-next/types is-plain-object type-fest universal-user-agent

Dev Dependencies

string-to-arraybuffer

Versions

octokit-next.js

Experimental Octokit SDK for exploration only - DO NOT USE 🚫⚠️

We use this repository to implement new features without the legacy of the current Octokit implementation.

This project is built as a monorepo using npm workspaces and is publishing native ES Modules. To set it up and run the tests Node 18 is required.

Currently working on:

octokit/octokit.js#2127 - Separate types from code and make types composable/extendable
octokit/octokit.js#2128 - Transition to native ES Modules + TypeScript declaration files

Usage

⚠️ This is an experimental SDK not meant for actual usage.

1import { Octokit } from "octokit-next";
2
3const octokit = new Octokit();
4
5const { data } = await octokit.request("GET /repos/{owner}/{repo}", {
6  owner: "octokit",
7  repo: "octokit-next.js",
8});
9
10console.log(data);

Breaking changes

A list of breaking changes compared to latest @octokit/* modules

Node 16 and other JavaScript runtime environments that lack a global fetch() method are no longer supported out-of-the-box. A fetch method such as provided by the node-fetch npm module can be passed to make Octokit work in these environments.

For @octokit-next/core and other SDKs built upon it you can do this
```
1import { Octokit } from "octokit-next";
2import fetch from "node-fetch";
3
4const octokit = new Octokit({ request: { fetch } });
```
For the static @octokit-next/request method you can do this
```
1import { request } from "@octokit-next/request";
2import fetch from "node-fetch";
3
4const result = await request("GET /", { request: { fetch } });
```
Octokit.defaults is now Octokit.withDefaults
Octokit.plugin is now Octokit.withPlugins. Instead of accepting one argument per plugin, the method now accepts a single array argument with all plugins to be applied.
@octokit/openapi-types will be renamed to @octokit/types-openapi to be consistents with the @octokit/types-* prefixed packages that only contain types
@octokit/auth-token: createTokenAuth() no longer accepts a token string argument, but requires options.token.
plugins now receive all options passed to the Octokit constructor as well as its defaults. Previously only the options passed to the constructor were passed

Features

Octokit.DEFAULTS
octokit.options

Notes for later

replace request.defaults() and endpoint.defaults() with request.withDefaults() and endpoint.withDefaults()
remove options.previews from new Octokit(options)
Add script to verify that packages/* folders and release.plugins configuration in package.json are in sync
scripts/types-rest-api-diff/update.js - remove all package folders before re-creating, so that obsolete packages get removed

Known issues

Constructor option Types (options.auth) are not set correctly when authStrategy is set via .withDefaults({ authStrategy }) (#20)
Endpoint types don't work if they changed between versions (#28)

License

MIT

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

SAST

Determines if the project uses static code analysis.

9

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.4

/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