Skip to content

fix: align js sdk request shaping with platform api #38

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
Shedna merged 1 commit into from
Jun 3, 2026
Merged

fix: align js sdk request shaping with platform api #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 35 additions & 7 deletions src/__tests__/linkup-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,42 @@ describe('LinkupClient', () => {
expect(mockAxiosInstance.post).toHaveBeenCalledWith('/search', {
depth: 'deep',
excludeDomains: ['baz.com', 'qux.com'],
fromDate: fromDate.toISOString(),
fromDate: '2025-01-01',
includeDomains: ['foo.com', 'bar.com'],
includeImages: true,
includeInlineCitations: true,
maxResults: 10,
outputType: 'sourcedAnswer',
q: 'foo',
toDate: toDate.toISOString(),
toDate: '2025-01-02',
});
});

it('should preserve explicit false flags and forward string dates as-is', async () => {
mockAxiosInstance.post.mockResolvedValueOnce({
data: { results: [] },
} as AxiosResponse);

await underTest.search({
depth: 'standard',
fromDate: '2026-05-01',
includeImages: false,
includeSources: false,
outputType: 'structured',
query: 'foo',
structuredOutputSchema: { type: 'string' },
toDate: '2026-05-31',
});

expect(mockAxiosInstance.post).toHaveBeenCalledWith('/search', {
depth: 'standard',
fromDate: '2026-05-01',
includeImages: false,
includeSources: false,
outputType: 'structured',
q: 'foo',
structuredOutputSchema: JSON.stringify({ type: 'string' }),
toDate: '2026-05-31',
});
});

Expand Down Expand Up @@ -373,7 +401,7 @@ describe('LinkupClient', () => {
error: null,
id: '2dbcc4bb-2c0d-4bcb-aaf5-44f7cbcf4eee',
input: {
mode: 'Auto',
mode: 'auto',
outputType: 'sourcedAnswer',
q: 'What changed?',
reasoningDepth: 'L',
Expand All @@ -395,7 +423,7 @@ describe('LinkupClient', () => {
q: 'What changed?',
});
expect(result.input).toEqual({
mode: 'Auto',
mode: 'auto',
outputType: 'sourcedAnswer',
query: 'What changed?',
reasoningDepth: 'L',
Expand All @@ -409,7 +437,7 @@ describe('LinkupClient', () => {
error: null,
id: 'abc-123',
input: {
mode: 'Auto',
mode: 'auto',
outputType: 'sourcedAnswer',
q: 'deep question',
reasoningDepth: 'XL',
Expand Down Expand Up @@ -708,11 +736,11 @@ describe('LinkupClient', () => {
},
},
{
description: '402 PAYMENT_REQUIRED',
description: '402 X402_PAYMENT_REQUIRED',
ErrorClass: LinkupPaymentRequiredError,
expectedMessage: 'Payment required',
input: {
error: { code: 'PAYMENT_REQUIRED', details: [], message: 'Payment required' },
error: { code: 'X402_PAYMENT_REQUIRED', details: [], message: 'Payment required' },
statusCode: 402,
},
},
Expand Down
24 changes: 14 additions & 10 deletions src/linkup-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,19 +161,19 @@ export class LinkupClient {
depth,
outputType,
q: query,
...(includeImages && { includeImages }),
...(includeImages !== undefined && { includeImages }),
...(includeDomains && { includeDomains }),
...(excludeDomains && { excludeDomains }),
...(fromDate && { fromDate: fromDate.toISOString() }),
...(toDate && { toDate: toDate.toISOString() }),
...(maxResults && { maxResults }),
...(fromDate && { fromDate: this.serializeDate(fromDate) }),
...(toDate && { toDate: this.serializeDate(toDate) }),
...(maxResults !== undefined && { maxResults }),
};

if ('includeInlineCitations' in params && params.includeInlineCitations) {
if ('includeInlineCitations' in params && params.includeInlineCitations !== undefined) {
result.includeInlineCitations = params.includeInlineCitations;
}

if ('includeSources' in params && params.includeSources) {
if ('includeSources' in params && params.includeSources !== undefined) {
result.includeSources = params.includeSources;
}

Expand Down Expand Up @@ -203,10 +203,10 @@ export class LinkupClient {
q: query,
...(includeDomains && { includeDomains }),
...(excludeDomains && { excludeDomains }),
...(fromDate && { fromDate: fromDate.toISOString() }),
...(toDate && { toDate: toDate.toISOString() }),
...(mode && { mode }),
...(reasoningDepth && { reasoningDepth }),
...(fromDate && { fromDate: this.serializeDate(fromDate) }),
...(toDate && { toDate: this.serializeDate(toDate) }),
...(mode !== undefined && { mode }),
...(reasoningDepth !== undefined && { reasoningDepth }),
};

if ('structuredOutputSchema' in params) {
Expand All @@ -224,6 +224,10 @@ export class LinkupClient {
);
}

private serializeDate(value: Date | string): string {
return value instanceof Date ? value.toISOString().slice(0, 10) : value;
}

private sanitizeTaskRequest(task: TaskRequest): {
input: SanitizedParams | FetchParams;
type: string;
Expand Down
4 changes: 2 additions & 2 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ type BaseSearchRequestParams = {
query: string;
includeDomains?: string[];
excludeDomains?: string[];
fromDate?: Date;
toDate?: Date;
fromDate?: Date | string;
toDate?: Date | string;
};

export type SearchParams = BaseSearchRequestParams & {
Expand Down