npmpackage.info

Gathering detailed insights and metrics for ts-api-toolkit

Other packages similar to ts-api-toolkit

@reduxjs/toolkit

2.3.0

The official, opinionated, batteries-included toolset for efficient Redux development

redux

5.0.1

Predictable state container for JavaScript apps

reselect

5.1.1

Selectors for Redux.

base

3.0.0

Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks

Gathering detailed insights and metrics for ts-api-toolkit

ts-api-toolkit

A wrapper around (Red)axios in combination with Json Web Token Handling to easily communicate with an API, with or without authorization.

2.0.16

MIT

TypeScript

1.36 kB

5,795 1.7

Installations

npm install ts-api-toolkit

Pull Requests

Open

0

Total

3

Closed

2

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

RyanChristian4427

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

14.16.0

NPM Version

6.14.13 Statistics

42 Stars

77 Commits

1 Forks

2 Watching

1 Branches

1 Contributors

Updated on 07 Jul 2022

Bundle Size

3.30 kB

Minified

1.36 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (92.86%)

JavaScript (7.14%)

Total Downloads

Cumulative downloads

Total Downloads

5,795

Last day

Compared to previous day

Last week

-78.9%

Compared to previous week

Last month

87.5%

Compared to previous month

Last year

-27.7%

508

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

redaxios

Dev Dependencies

@types/jest @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier karmatic microbundle prettier ts-loader typescript webpack

Versions

TS-API-Toolkit

TS-API-Toolkit is a simple way to handle your API calls as well as your localStorage JWT management. The library offers a simple wrapper around redaxios in conjunction with a service to handle your JWTs. No longer will you need to attach tokens to every request or even manually worry about them. Just set the token, and it'll be attached to every call you make.

Install

$ yarn add ts-api-toolkit

Usage

1import apiToolkit from 'ts-api-toolkit';
2
3const { data: { user } } = await apiToolkit.post('users/login', credentials);
4authStorageService.saveToken(user.token);

API

This library offers two class instance exports, ApiSerivce and AuthStorageService. Using these you can easily handle your application.

import { authStorageService } from 'ts-api-toolkit'

Provides an instance of AuthStorageService.

.changeTokenKey(tokenKey: string): void

Changes the key your token is stored under in localStorage.

The token key is what identifies your token as it is saved in a browser's localStorage. The value from that key is attached to every API request.
.getToken(): string

Retrieves the current value for your token key. If a value cannot be found, returns an empty string.
.saveToken(token: string): void

Saves a provided token into localStorage using the tokenKey.

The token you save will be used with all future API requests, until it is removed or changed.
.destroyToken(): void

Removes the currently stored token key and value.

import { apiService } from 'ts-api-toolkit'

Provides an instance of ApiService.

.changeBaseUrl(baseUrl: string): void

Changes the base URL to use when making requests.

Use the baseUrl parameter to describe your base API URL. Use a partial route like /api if you want to use a proxy, otherwise, set the full route to your API like http://example.com/api. The default baseUrl is /api/v1.
.changeAuthSchema(authSchema: string): void

Changes the scheme used in the Authorization header.

Use the authSchema parameter to describe the prefix to the token. The default is set to Bearer, so, unedited, all API requests will come with the following header: Authorization: 'Bearer <auth-token>'
.get(resource: string, params?: Record<string, unknown>): Promise

GET request
.post(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

POST request
.put(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

PUT request
.patch(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

PATCH request
.delete(resource: string, params: Record<string, unknown>, params?: Record<string, unknown>): Promise

DELETE request
.options(resource: string, params?: Record<string, unknown>): Promise

OPTIONS request

All requests use the Authorization header to send the current token in localStorage, regardless of whether it is empty.

Query parameters will all be properly serialized, no need to provide anything beyond an object.

`{ name: 'ferret', color: 'purple' }` -> `?name=ferret&color=purple`

License

No vulnerabilities found.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

0

Code-Review

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

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

65 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg

Score

1.7

/10

Last Scanned on 2024-11-25

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

Other packages similar to ts-api-toolkit

Other packages similar to ts-api-toolkit

ts-api-toolkit

Installations

Pull Requests

0

3

2

1

Issues

0

0

0

Releases

Unable to fetch releases

Developer

RyanChristian4427

Developer Guide

CommonJS, ESM

Yes

14.16.0

6.14.13

Statistics

Bundle Size

3.30 kB

1.36 kB

Languages

Total Downloads

5,795

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

TS-API-Toolkit

Install

Usage

API

import { authStorageService } from 'ts-api-toolkit'

.changeTokenKey(tokenKey: string): void

.getToken(): string

.saveToken(token: string): void

.destroyToken(): void

import { apiService } from 'ts-api-toolkit'

.changeBaseUrl(baseUrl: string): void

.changeAuthSchema(authSchema: string): void

.get(resource: string, params?: Record<string, unknown>): Promise

.post(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

.put(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

.patch(resource: string, data: Record<string, unknown>, params?: Record<string, unknown>): Promise

.delete(resource: string, params: Record<string, unknown>, params?: Record<string, unknown>): Promise

.options(resource: string, params?: Record<string, unknown>): Promise

License

10

10

0

0

0

0

0

0

0

0

1.7

/10