Installations
npm install @arutkowski00/openapi-client-axios-typegen
Developer Guide
Typescript
Yes
Module System
CommonJS
Node Version
10.24.1
NPM Version
6.14.12
Score
57.2
Supply Chain
78.7
Quality
71.6
Maintenance
50
Vulnerability
97.6
License
Releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (99.1%)
JavaScript (0.8%)
Shell (0.1%)
Developer
Download Statistics
Total Downloads
314
Last Day
1
Last Week
1
Last Month
6
Last Year
52
GitHub Statistics
577 Stars
448 Commits
68 Forks
7 Watching
7 Branches
27 Contributors
Bundle Size
441.41 kB
Minified
128.63 kB
Minified + Gzipped
Package Meta Information
Latest Version
3.14.1-patch.1
Package Id
@arutkowski00/openapi-client-axios-typegen@3.14.1-patch.1
Unpacked Size
19.16 kB
Size
6.79 kB
File Count
6
NPM Version
6.14.12
Node Version
10.24.1
Total Downloads
Cumulative downloads
Total Downloads
314
Last day
0%
1
Compared to previous day
Last week
0%
1
Compared to previous week
Last month
50%
6
Compared to previous month
Last year
-53.6%
52
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
OpenAPI Client Axios Typegen
Type generator for openapi-client-axios
Generating type files (.d.ts)
openapi-client-axios
comes with a tool called typegen
to generate typescript type files (.d.ts) for
OpenAPIClient instances using an OpenAPI definition file.
$ npm install -g openapi-client-axios-typegen
Usage: typegen [file]
Options:
--help Show help [boolean]
--version Show version number [boolean]
Examples:
typegen ./openapi.yml > client.d.ts - generate a type definition file
The output of typegen
exports a type called Client
, which can be used for instances created with OpenAPIClientAxios
.
Both the api.getClient()
and api.init()
methods support passing in a Client type.
1import { Client as PetStoreClient } from './client.d.ts'; 2 3const client = await api.init<PetStoreClient>(); 4const client = await api.getClient<PetStoreClient>();
typegen
supports using both local and remote URLs for OpenAPI definition files.
$ typegen ./petstore.yaml
$ typegen https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
Contributing
OpenAPI Client Axios Typegen is Free and Open Source Software. Issues and pull requests are more than welcome!
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 12 commits out of 14 are checked with a SAST tool
Reason
Found 5/21 approved changesets -- score normalized to 2
Reason
8 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Reason
0 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 1
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/openapistack/openapi-client-axios/codeql.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:24
- Info: 0 out of 8 GitHub-owned 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.yml:16
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:17
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql.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
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Score
4
/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