Skip to content

fix: align Domain API schemas with BuiltWith v23 docs #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zcaceres merged 3 commits into from
Jul 8, 2026
Merged

fix: align Domain API schemas with BuiltWith v23 docs #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ff0543
fix: align Domain API schemas with BuiltWith v23 docs
zcaceres Jul 8, 2026
4ad30f6
fix: mark intermittently-absent Domain fields optional
zcaceres Jul 8, 2026
d23e73d
fix: mark Meta.Social optional
zcaceres Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ builtwith domain "example.com,other.com"
| `--noMetaData` | Exclude metadata |
| `--noAttributeData` | Exclude attribute data |
| `--noPII` | Exclude personally identifiable information |
| `--firstDetectedRange` | Filter by first detected date range |
| `--lastDetectedRange` | Filter by last detected date range |
| `--includeTrust` | Include Trust API data (uses an additional API credit) |
| `--firstDetectedRange` | Filter by first detected date range (`YYYY-MM-DD` or `YYYY-MM-DD\|YYYY-MM-DD`) |
| `--lastDetectedRange` | Filter by last detected date range (`YYYY-MM-DD` or `YYYY-MM-DD\|YYYY-MM-DD`) |

### `domainLive`

Expand Down
5 changes: 3 additions & 2 deletions docs/guide/library.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ const filtered = await client.domain("example.com", {
| `noMetaData` | `boolean` | Exclude company metadata |
| `noAttributeData` | `boolean` | Exclude attribute data |
| `noPII` | `boolean` | Exclude personally identifiable information |
| `firstDetectedRange` | `string` | Filter by first detected date range |
| `lastDetectedRange` | `string` | Filter by last detected date range |
| `includeTrust` | `boolean` | Include Trust API data (uses an additional API credit) |
| `firstDetectedRange` | `string` | Filter by first detected date range (`YYYY-MM-DD` or `YYYY-MM-DD\|YYYY-MM-DD`) |
| `lastDetectedRange` | `string` | Filter by last detected date range (`YYYY-MM-DD` or `YYYY-MM-DD\|YYYY-MM-DD`) |

### `domainLive(lookup)`

Expand Down
15 changes: 13 additions & 2 deletions packages/builtwith-api/src/commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,24 @@ export const commands: CommandDefinition[] = [
{ name: "noMetaData", description: "Exclude metadata", type: "boolean", required: false },
{ name: "noAttributeData", description: "Exclude attribute data", type: "boolean", required: false },
{ name: "noPII", description: "Exclude personally identifiable information", type: "boolean", required: false },
{
name: "includeTrust",
description: "Include Trust API data (uses an additional API credit)",
type: "boolean",
required: false,
},
{
name: "firstDetectedRange",
description: "Filter by first detected date range",
description: "Filter by first detected date range (YYYY-MM-DD|YYYY-MM-DD)",
type: "string",
required: false,
},
{
name: "lastDetectedRange",
description: "Filter by last detected date range (YYYY-MM-DD|YYYY-MM-DD)",
type: "string",
required: false,
},
{ name: "lastDetectedRange", description: "Filter by last detected date range", type: "string", required: false },
],
execute: (client, args) => {
const lookup = splitLookup(args.lookup);
Expand Down
1 change: 1 addition & 0 deletions packages/builtwith-api/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const DOMAIN_BOOLEANS: BooleanMapping = {
noMetaData: "NOMETA",
noAttributeData: "NOATTR",
noPII: "NOPII",
includeTrust: "TRUST",
};

/**
Expand Down
19 changes: 12 additions & 7 deletions packages/builtwith-api/src/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ export const ClientOptionsSchema = z.strictObject({
*/
export type ClientOptions = z.infer<typeof ClientOptionsSchema>;

/** Matches YYYY-MM-DD or YYYY-MM-DD-YYYY-MM-DD date range format. */
const dateRangePattern = /^\d{4}-\d{2}-\d{2}(-\d{4}-\d{2}-\d{2})?$/;
/** Matches YYYY-MM-DD or a pipe-joined YYYY-MM-DD|YYYY-MM-DD range (v23 FDRANGE/LDRANGE format). */
const dateRangePattern = /^\d{4}-\d{2}-\d{2}(\|\d{4}-\d{2}-\d{2})?$/;

/** Validation schema for {@link DomainParams}. */
export const DomainParamsSchema = z.strictObject({
Expand All @@ -37,8 +37,9 @@ export const DomainParamsSchema = z.strictObject({
noMetaData: z.boolean().optional(),
noAttributeData: z.boolean().optional(),
noPII: z.boolean().optional(),
firstDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD-YYYY-MM-DD").optional(),
lastDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD-YYYY-MM-DD").optional(),
includeTrust: z.boolean().optional(),
firstDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD|YYYY-MM-DD").optional(),
lastDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD|YYYY-MM-DD").optional(),
});
/**
* Optional parameters for the Domain API endpoint.
Expand Down Expand Up @@ -171,8 +172,9 @@ const PathSchema = z.strictObject({

const MetaSchema = z.strictObject({
Majestic: z.number(),
Umbrella: z.number().optional(),
Vertical: z.string(),
Social: z.array(z.string()),
Social: z.array(z.string()).optional(),
CompanyName: z.string(),
Telephones: z.array(z.string()),
Emails: z.array(z.string()),
Expand Down Expand Up @@ -205,14 +207,17 @@ const AttributesSchema = z.strictObject({
CDimensions: z.number(),
CGoals: z.number(),
CMetrics: z.number(),
Followers: z.number(),
Employees: z.number(),
Followers: z.number().optional(),
Employees: z.number().optional(),
ProductCount: z.number().optional(),
Revenue: z.number().optional(),
PageRank: z.number().optional(),
BWRank: z.number().optional(),
Tranco: z.number().optional(),
BWS: z.number().optional(),
EcommerceCategory: z.number().optional(),
TTFB: z.number().optional(),
SourceBytes: z.number().optional(),
AIMaturity: z.number().optional(),
AIOpenness: z.number().optional(),
AIReadiness: z.number().optional(),
Expand Down
8 changes: 6 additions & 2 deletions packages/builtwith-api/test/params.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,12 @@ describe("date range validation", () => {
expect(() => DomainParamsSchema.parse({ firstDetectedRange: "2024-01-15" })).not.toThrow();
});

it("accepts YYYY-MM-DD-YYYY-MM-DD range format", () => {
expect(() => DomainParamsSchema.parse({ firstDetectedRange: "2020-01-01-2024-12-31" })).not.toThrow();
it("accepts pipe-joined YYYY-MM-DD|YYYY-MM-DD range format", () => {
expect(() => DomainParamsSchema.parse({ firstDetectedRange: "2020-01-01|2024-12-31" })).not.toThrow();
});

it("rejects the legacy dash-joined range format", () => {
expect(() => DomainParamsSchema.parse({ firstDetectedRange: "2020-01-01-2024-12-31" })).toThrow();
});

it("accepts lastDetectedRange with valid format", () => {
Expand Down
1 change: 1 addition & 0 deletions packages/builtwith-api/test/schemas.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ describe("DomainResponseSchema", () => {
},
Meta: {
Majestic: 12345,
Umbrella: 6423,
Vertical: "Technology",
Social: ["https://twitter.com/example"],
CompanyName: "Example Inc",
Expand Down
Loading