{"id":47609758,"url":"https://github.com/matthewvolk/bigrequest","last_synced_at":"2026-04-01T19:59:17.301Z","repository":{"id":113315379,"uuid":"399259876","full_name":"matthewvolk/bigrequest","owner":"matthewvolk","description":"💸 A lightweight, typesafe, serverless-friendly Node.js HTTP client for the BigCommerce API","archived":false,"fork":false,"pushed_at":"2026-03-19T23:10:23.000Z","size":2527,"stargazers_count":10,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-20T14:07:10.604Z","etag":null,"topics":["api-client","bigcommerce","https","nodejs","npm-package","request","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/bigrequest","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matthewvolk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-23T22:05:46.000Z","updated_at":"2026-03-19T23:10:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"e478aa17-9ce2-4d6e-94a0-f130762266dd","html_url":"https://github.com/matthewvolk/bigrequest","commit_stats":null,"previous_names":["matthewvolk/bigrequest"],"tags_count":121,"template":false,"template_full_name":null,"purl":"pkg:github/matthewvolk/bigrequest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewvolk%2Fbigrequest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewvolk%2Fbigrequest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewvolk%2Fbigrequest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewvolk%2Fbigrequest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthewvolk","download_url":"https://codeload.github.com/matthewvolk/bigrequest/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewvolk%2Fbigrequest/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31291333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","bigcommerce","https","nodejs","npm-package","request","typescript"],"created_at":"2026-04-01T19:59:16.536Z","updated_at":"2026-04-01T19:59:17.294Z","avatar_url":"https://github.com/matthewvolk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BigRequest\n\nA typesafe, serverless-friendly Node.js HTTP request client for the BigCommerce API. Includes OAuth2 authorization flows for Single-Click App developers.\n\n## Overview\n\nThis module is available in two formats:\n\n- **ES Module:** `dist/index.mjs`\n- **CommonJS:** `dist/index.js`\n\n## Requirements\n\n- **Node.js:** `\u003e=18`\n\n## Installation\n\n\u003e **⚠️ Important ⚠️**\n\u003e 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.\n\n```sh\nnpm i bigrequest --save-exact\n```\n\n## Usage\n\n```ts\n// Typescript\nimport bigrequest from 'bigrequest';\n```\n\n```js\n// CommonJS\nconst bigrequest = require('bigrequest');\n```\n\n```js\n// ES Module\nimport bigrequest from 'bigrequest';\n```\n\n### REST Management API\n\n```ts\nconst bc = bigrequest.rest({\n  storeHash: 'your_store_hash',\n  accessToken: 'your_access_token',\n});\n\n// Use the REST client\nconst product = await bc.v3.GET('/catalog/products/{product_id}', {\n  params: {\n    header: { Accept: 'application/json' },\n    path: { product_id: 111 },\n  },\n});\n\n/**\n * product: {\n *   data:\n *     | {\n *         data: {\n *           id?: number | undefined;\n *           name: string;\n *           type: \"physical\" | \"digital\";\n *           sku?: string | undefined;\n *           ...\n *         };\n *         meta: {};\n *       }\n *     | undefined;\n *   errors:\n *     | {\n *         status?: number | undefined;\n *         title?: string | undefined;\n *         type?: string | undefined;\n *         instance?: string | undefined;\n *       }\n *     | undefined;\n *   response: Response;\n * }\n */\n\n// Creating an image using FormData\nconst categoryImage = await bc.v3.POST('/catalog/categories/{category_id}/image', {\n  params: {\n    header: {\n      'Content-Type': 'multipart/form-data',\n      Accept: 'application/json',\n    },\n    path: { category_id: 11 },\n  },\n  body: {\n    image_file: 'path/to/image.jpg',\n  },\n  bodySerializer(body) {\n    const fd = new FormData();\n\n    /**\n     * body: {\n     *   image_file: \"path/to/image.jpg\"\n     * }\n     */\n    for (const [k, v] of Object.entries(body)) {\n      const blob = new Blob([fs.readFileSync(v)]);\n\n      fd.append(k, blob, 'DESIRED_FILE_NAME.jpg');\n    }\n\n    return fd;\n  },\n});\n```\n\n### OAuth\n\n```ts\nconst oauth = bigrequest.oauth({\n  clientId: 'YOUR_CLIENT_ID',\n  clientSecret: 'YOUR_CLIENT_SECRET',\n  authCallback: 'https://devtools.bigcommerce.com/my/apps',\n});\n\n// Receive the auth callback\nconst accessTokenResponse = await oauth.authorize({\n  code: 'code',\n  context: 'context',\n  scope: 'scope',\n});\n\n/**\n * accessTokenResponse: {\n *   scope: string;\n *   context: string;\n *   access_token: string;\n *   user: {\n *     id: number;\n *     username: string;\n *     email: string;\n *   }\n *   account_uuid: string;\n * }\n */\n\n// Receive the load/uninstall/remove_user callback\nconst signedJwtPayload = await oauth.verify('signed_payload_jwt');\n\n/**\n * signedJwtPayload: {\n *   user: {\n *     id: number;\n *     email: string;\n *     locale: string;\n *   }\n *   aud: string;\n *   iss: string;\n *   iat: number;\n *   nbf: number;\n *   exp: number;\n *   jti: string;\n *   sub: string;\n *   owner: {\n *     id: number;\n *     email: string;\n *   }\n *   url: string;\n *   channel_id: number | null;\n * }\n */\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewvolk%2Fbigrequest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthewvolk%2Fbigrequest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewvolk%2Fbigrequest/lists"}