Sellers.json
Sellers.JSON generator, parser and validator
About
Sellers.json is an online advertising specification for sharing supply-side information regarding who is selling a piece of inventory. The specification details a JSON file formatted in a strict manner that lists properties that may assist demand-side systems in validating inventory. The file lists an array of sellers, as well as identifiers, contact information and other miscellaneous properties.
This library provides a toolkit for working with sellers.json data, and it can:
- Generate new
sellers.json
files - Read and modify extisting files
- Validate
sellers.json
data
The library is a lightweight NodeJS project designed to work on NodeJS version 8 and newer.
Installation
Install by running npm install sellers.json --save
.
Usage
For validation, the assertValidSellersJSON
and validateSellersJSON
methods are provided to assert validity (and throw an error if invalid) and validate sellers.json data respectively:
const fs = ;const assertValidSellersJSON validateSellersJSON = ; // Get sellers.json data somehowconst sellersJSONData = JSON; // Throw an error if the data is invalid; // Check for validity issues:const errors = ;// Each error will resemble:// {// path: "some.deep.property",// message: "Property was invalid"// }
The SellersFixture
is a class designed to assist with constructing valid sellers.json data. You can create a new instance or load it from existing data:
const fs = ;const SellersFixture = ; const sellersJSON = fs; // Existing payloadconst fixtureExisting = SellersFixture; // Or: `SellersFixture.fromJSON(JSON.parse(sellersJSON)` // New instanceconst fixtureNew = ;
You can then use the fixture's helper methods to configure the file:
fixturecontactAddress = "123 Test Lane";fixturecontactEmail = "user@example.com";fixture;fixture; const seller = fixture;sellerdirectness = "BOTH";sellername = "Test Seller";sellerisConfidential = false;// Seller changes in `Seller` instance are applied automatically
See Also
- Ads.txt:
ads.txt
parser, generator and validator