@nextad/bid-requester

Typescript bid requester library compliant with OpenRTB 2.5/2.6/3.0

Features

- 🎯 Full TypeScript type definitions support
- 📝 Compliant with OpenRTB
- 🛠️ Support for ESM and CommonJS
- ⚡ Can be used without instantiation
- 🧪 Test-friendly interface

Installation

npm:

``
npm install @nextad/bid-requester
`

pnpm:

`
pnpm add @nextad/bid-requester
`

Usage

$3

`typescript
import { bidRequester } from "@nextad/bid-requester";
import { BidRequest, BidResponse } from "iab-openrtb/v26";

const bidRequest: BidRequest = {
id: "bid-request-1",
imp: [
{
id: "1",
banner: {
w: 300,
h: 250,
},
},
],
};

const bidResponse = await bidRequester.requestV26(
"https://example.com/endpoint",
bidRequest,
{
customHeaders: {
Token: "auth-token",
},
}
);
`

$3

`typescript
const bidResponseV25 = await bidRequester.requestV25(
"https://example.com/v25",
bidRequestV25
);
const bidResponseV26 = await bidRequester.requestV26(
"https://example.com/v26",
bidRequestV26
);
const bidResponseV30 = await bidRequester.requestV30(
"https://example.com/v30",
bidRequestV30
);
`

$3

`typescript
import {
InvalidBidRequestException, // 400 Bad Request
NoBidReasonException, // 204 No Content
UnexpectedError, // other than 200, 204 400
} from "@nextad/bid-requester";

try {
const bidResponse = await bidRequester.requestV26(
"https://example.com/endpoint",
bidRequest
);
} catch (error) {
if (error instanceof InvalidBidRequestException) {
// error handling...
}
}
`

$3

Test-friendly interface available

`typescript
import { IBidRequester } from "@nextad/bid-requester";

const bidRequesterMock = mock();
`

$3

If you want to change from OpenRTB recommended data encoding and data format, you can use options.

Available options:

`typescript
export type BidRequesterOptions = {
dataFormat?: string; // Corresponds to Content-Type (defaults to application/json)
acceptEncoding?: string; // Corresponds to Accept-Encoding (defaults to gzip)
contentEncoding?: string; // Corresponds to Content-Encoding (default to gzip)
customHeaders?: Record; // Custom Headers
withCredentials?: boolean; // Include authentication credentials (cookies, TLS client certs)
};
`

Usage:

`typescript
import { BidRequester } from "@nextad/bid-requester";
import { BidRequest, BidResponse } from "iab-openrtb/v26";

// Common options
const bidRequester = new BidRequester({
acceptEncoding: "*",
contentEncoding: "*",
});

const bidRequest: BidRequest = {
id: "bid-request-1",
imp: [
{
id: "1",
banner: {
w: 300,
h: 250,
},
},
],
};

const bidResponse = await bidRequester.requestV26(
"https://example.com/endpoint",
bidRequest,
{ // Specific options
acceptEncoding: "gzip",
contentEncoding: "gzip",
}
);
``

License

MIT License