https://github.com/matthewvolk/bigrequest
💸 A lightweight, typesafe, serverless-friendly Node.js HTTP client for the BigCommerce API
https://github.com/matthewvolk/bigrequest
api-client bigcommerce https nodejs npm-package request typescript
Last synced: about 2 months ago
JSON representation
💸 A lightweight, typesafe, serverless-friendly Node.js HTTP client for the BigCommerce API
- Host: GitHub
- URL: https://github.com/matthewvolk/bigrequest
- Owner: matthewvolk
- License: mit
- Created: 2021-08-23T22:05:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-19T23:10:23.000Z (about 2 months ago)
- Last Synced: 2026-03-20T14:07:10.604Z (about 2 months ago)
- Topics: api-client, bigcommerce, https, nodejs, npm-package, request, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/bigrequest
- Size: 2.41 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# BigRequest
A typesafe, serverless-friendly Node.js HTTP request client for the BigCommerce API. Includes OAuth2 authorization flows for Single-Click App developers.
## Overview
This module is available in two formats:
- **ES Module:** `dist/index.mjs`
- **CommonJS:** `dist/index.js`
## Requirements
- **Node.js:** `>=18`
## Installation
> **⚠️ Important ⚠️**
> It's important to install this package with the `--save-exact` flag. Until this package reaches version `1.0.0`, there may be breaking changes released with patch/minor versions.
```sh
npm i bigrequest --save-exact
```
## Usage
```ts
// Typescript
import bigrequest from 'bigrequest';
```
```js
// CommonJS
const bigrequest = require('bigrequest');
```
```js
// ES Module
import bigrequest from 'bigrequest';
```
### REST Management API
```ts
const bc = bigrequest.rest({
storeHash: 'your_store_hash',
accessToken: 'your_access_token',
});
// Use the REST client
const product = await bc.v3.GET('/catalog/products/{product_id}', {
params: {
header: { Accept: 'application/json' },
path: { product_id: 111 },
},
});
/**
* product: {
* data:
* | {
* data: {
* id?: number | undefined;
* name: string;
* type: "physical" | "digital";
* sku?: string | undefined;
* ...
* };
* meta: {};
* }
* | undefined;
* errors:
* | {
* status?: number | undefined;
* title?: string | undefined;
* type?: string | undefined;
* instance?: string | undefined;
* }
* | undefined;
* response: Response;
* }
*/
// Creating an image using FormData
const categoryImage = await bc.v3.POST('/catalog/categories/{category_id}/image', {
params: {
header: {
'Content-Type': 'multipart/form-data',
Accept: 'application/json',
},
path: { category_id: 11 },
},
body: {
image_file: 'path/to/image.jpg',
},
bodySerializer(body) {
const fd = new FormData();
/**
* body: {
* image_file: "path/to/image.jpg"
* }
*/
for (const [k, v] of Object.entries(body)) {
const blob = new Blob([fs.readFileSync(v)]);
fd.append(k, blob, 'DESIRED_FILE_NAME.jpg');
}
return fd;
},
});
```
### OAuth
```ts
const oauth = bigrequest.oauth({
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
authCallback: 'https://devtools.bigcommerce.com/my/apps',
});
// Receive the auth callback
const accessTokenResponse = await oauth.authorize({
code: 'code',
context: 'context',
scope: 'scope',
});
/**
* accessTokenResponse: {
* scope: string;
* context: string;
* access_token: string;
* user: {
* id: number;
* username: string;
* email: string;
* }
* account_uuid: string;
* }
*/
// Receive the load/uninstall/remove_user callback
const signedJwtPayload = await oauth.verify('signed_payload_jwt');
/**
* signedJwtPayload: {
* user: {
* id: number;
* email: string;
* locale: string;
* }
* aud: string;
* iss: string;
* iat: number;
* nbf: number;
* exp: number;
* jti: string;
* sub: string;
* owner: {
* id: number;
* email: string;
* }
* url: string;
* channel_id: number | null;
* }
*/
```
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)