Package Health Score

90 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.20.0	\|	10/2024		0 C 0 H 0 M 0 L	1 H 0 M 0 L
2.19.0	\|	09/2024		0 C 0 H 0 M 0 L	1 H 0 M 0 L
2.10.0	\|	10/2023	Popular	0 C 0 H 0 M 0 L	1 H 0 M 0 L
0.0.71	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (431)

GitHub Stars: 34.11K
Forks: 9.72K
Contributors: 130

Direct Usage Popularity

The npm package @halo-dev/api-client receives a total of 431 downloads a week. As such, we scored @halo-dev/api-client popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @halo-dev/api-client, we found that it has been starred 34,114 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 130
Funding: Yes

A good and healthy external contribution signal for @halo-dev/api-client project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 317
Open PR: 5
Last Release: 2 months ago
Last Commit: 27 days ago

Further analysis of the maintenance status of @halo-dev/api-client based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @halo-dev/api-client demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 1 Direct
Versions: 99
Install Size: 8.43 MB
Dist-tags: 1
# of Files: 344
Maintainers: 2
TS Typings: No

@halo-dev/api-client has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@halo-dev/api-client

Halo 2.0 的 JavaScript API 客户端请求库。使用 OpenAPI Generator 生成。

使用

import {
  coreApiClient,
  consoleApiClient,
  ucApiClient,
  publicApiClient,
  createCoreApiClient,
  createConsoleApiClient,
  createUcApiClient,
  createPublicApiClient,
  axiosInstance
} from "@halo-dev/api-client"

coreApiClient: 为 Halo 所有自定义模型的 CRUD 接口封装的 api client。
consoleApiClient: 为 Halo 针对 Console 提供的接口封装的 api client。
ucApiClient: 为 Halo 针对 UC 提供的接口封装的 api client。
publicApiClient: 为 Halo 所有公开访问的接口封装的 api client。
createCoreApiClient: 用于创建自定义模型的 CRUD 接口封装的 api client，需要传入 axios 实例。
createConsoleApiClient: 用于创建 Console 接口封装的 api client，需要传入 axios 实例。
createUcApiClient: 用于创建 UC 接口封装的 api client，需要传入 axios 实例。
createPublicApiClient: 用于创建公开访问接口封装的 api client，需要传入 axios 实例。
axiosInstance: 内部默认创建的 axios 实例。

在插件中使用

pnpm install @halo-dev/api-client axios

由于已经在 Console 和 UC 项目中引入并设置好了 Axios 拦截器，所以直接使用即可：

import { coreApiClient } from "@halo-dev/api-client"

coreApiClient.content.post.listPost().then(response => {
  // handle response
})

此外，在最新的 @halo-dev/ui-plugin-bundler-kit@2.17.0 中，已经排除了 @halo-dev/api-client、axios 依赖，所以最终产物中的相关依赖会自动使用 Halo 本身提供的依赖，无需关心最终产物大小。

详细文档可查阅：插件开发 / API 请求

在外部项目中使用

pnpm install @halo-dev/api-client axios

import axios from "axios"

const axiosInstance = axios.create({
  baseURL: "https://localhost:8090"
})

const coreApiClient = createCoreApiClient(axiosInstance)

coreApiClient.content.post.listPost().then(response => {
  // handle response
})

@halo-dev/api-client dependencies

@halo-dev/api-client development dependencies

@openapitools/openapi-generator-cli @types/node @types/qs rimraf typescript unbuild vite-plugin-dts

FAQs

What is @halo-dev/api-client?

API Client for Halo 2. Visit Snyk Advisor to see a full health score report for @halo-dev/api-client, including popularity, security, maintenance & community analysis.

Is @halo-dev/api-client popular?

The npm package @halo-dev/api-client receives a total of 431 weekly downloads. As such, @halo-dev/api-client popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @halo-dev/api-client well maintained?

We found that @halo-dev/api-client demonstrated a healthy version release cadence and project activity. It has a community of 130 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @halo-dev/api-client safe to use?

The npm package @halo-dev/api-client was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 25 November-2024, at 09:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

@halo-dev/api-client

API Client for Halo 2 For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Non-Permissive License

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (431)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

@halo-dev/api-client

使用

在插件中使用

在外部项目中使用

@halo-dev/api-client dependencies

@halo-dev/api-client development dependencies

FAQs

What is @halo-dev/api-client?

Is @halo-dev/api-client popular?

Is @halo-dev/api-client well maintained?

Is @halo-dev/api-client safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (431)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@halo-dev/api-client

使用

在插件中使用

在外部项目中使用

@halo-dev/api-client dependencies

@halo-dev/api-client development dependencies

FAQs

What is @halo-dev/api-client?

Is @halo-dev/api-client popular?

Is @halo-dev/api-client well maintained?

Is @halo-dev/api-client safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues