linkup-sdk 2.1.1 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/linkup-client.d.ts.map +1 -1
- package/dist/linkup-client.js +2 -1
- package/dist/linkup-client.js.map +1 -1
- package/dist/types.d.ts +9 -2
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,9 +75,11 @@ askLinkup()
|
|
|
75
75
|
|
|
76
76
|
You can use the fetch endpoint to retrieve the content of a given URL in clean `markdown` format.
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Use `renderJs` to execute the JavaScript code of the page before returning the content.
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Use `includeRawHtml` to get the raw HTML of the page.
|
|
81
|
+
|
|
82
|
+
Use `extractImages` to get an extracted list of images from the page.
|
|
81
83
|
|
|
82
84
|
#### 📝 Example
|
|
83
85
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkup-client.d.ts","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EAGb,MAAM,SAAS,CAAC;AAIjB,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;gBAE3B,MAAM,EAAE,SAAS;IAsBvB,MAAM,CAAC,CAAC,SAAS,gBAAgB,EACrC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAM7B,KAAK,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI9E,OAAO,CAAC,cAAc;
|
|
1
|
+
{"version":3,"file":"linkup-client.d.ts","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EAGb,MAAM,SAAS,CAAC;AAIjB,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;gBAE3B,MAAM,EAAE,SAAS;IAsBvB,MAAM,CAAC,CAAC,SAAS,gBAAgB,EACrC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAM7B,KAAK,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI9E,OAAO,CAAC,cAAc;IAgCtB,OAAO,CAAC,cAAc;CAoBvB"}
|
package/dist/linkup-client.js
CHANGED
|
@@ -35,7 +35,7 @@ class LinkupClient {
|
|
|
35
35
|
async fetch(params) {
|
|
36
36
|
return this.client.post('/fetch', params).then(response => response.data);
|
|
37
37
|
}
|
|
38
|
-
sanitizeParams({ query, depth, outputType, includeImages, structuredOutputSchema, includeDomains, excludeDomains, fromDate, toDate, }) {
|
|
38
|
+
sanitizeParams({ query, depth, outputType, includeImages, structuredOutputSchema, includeDomains, excludeDomains, fromDate, toDate, includeInlineCitations, }) {
|
|
39
39
|
return {
|
|
40
40
|
depth,
|
|
41
41
|
outputType,
|
|
@@ -45,6 +45,7 @@ class LinkupClient {
|
|
|
45
45
|
...(excludeDomains && { excludeDomains }),
|
|
46
46
|
...(fromDate && { fromDate: fromDate.toISOString() }),
|
|
47
47
|
...(toDate && { toDate: toDate.toISOString() }),
|
|
48
|
+
...(includeInlineCitations && { includeInlineCitations }),
|
|
48
49
|
...(structuredOutputSchema && {
|
|
49
50
|
structuredOutputSchema: JSON.stringify((0, schema_utils_1.isZodObject)(structuredOutputSchema)
|
|
50
51
|
? (0, zod_to_json_schema_1.default)(structuredOutputSchema)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkup-client.js","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAE7C,4EAAiD;AAWjD,mEAAyD;AACzD,uDAAmD;AAEnD,MAAa,YAAY;IACN,UAAU,GAAG,qBAAqB,CAAC;IACnC,MAAM,CAAgB;IAEvC,YAAY,MAAiB;QAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,0BAA0B,CAAC;QAE7D,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO;YACP,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE;gBACxC,YAAY,EAAE,IAAI,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACnC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,KAAK,CAAC,EAAE;YACN,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC5C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,IAAA,gCAAW,EAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aAC5C,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,KAAK,CAAwB,MAAS;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAEO,cAAc,CAA6B,EACjD,KAAK,EACL,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,cAAc,EACd,QAAQ,EACR,MAAM,
|
|
1
|
+
{"version":3,"file":"linkup-client.js","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAE7C,4EAAiD;AAWjD,mEAAyD;AACzD,uDAAmD;AAEnD,MAAa,YAAY;IACN,UAAU,GAAG,qBAAqB,CAAC;IACnC,MAAM,CAAgB;IAEvC,YAAY,MAAiB;QAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,0BAA0B,CAAC;QAE7D,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO;YACP,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE;gBACxC,YAAY,EAAE,IAAI,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACnC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,KAAK,CAAC,EAAE;YACN,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC5C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,IAAA,gCAAW,EAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aAC5C,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,KAAK,CAAwB,MAAS;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAEO,cAAc,CAA6B,EACjD,KAAK,EACL,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,cAAc,EACd,QAAQ,EACR,MAAM,EACN,sBAAsB,GACN;QAChB,OAAO;YACL,KAAK;YACL,UAAU;YACV,CAAC,EAAE,KAAK;YACR,GAAG,CAAC,aAAa,IAAI,EAAE,aAAa,EAAE,CAAC;YACvC,GAAG,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,CAAC;YACzC,GAAG,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,CAAC;YACzC,GAAG,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;YACrD,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/C,GAAG,CAAC,sBAAsB,IAAI,EAAE,sBAAsB,EAAE,CAAC;YACzD,GAAG,CAAC,sBAAsB,IAAI;gBAC5B,sBAAsB,EAAE,IAAI,CAAC,SAAS,CACpC,IAAA,0BAAW,EAAC,sBAAsB,CAAC;oBACjC,CAAC,CAAC,IAAA,4BAAe,EAAC,sBAAgD,CAAC;oBACnE,CAAC,CAAC,sBAAsB,CAC3B;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAEO,cAAc,CACpB,cAAuB,EACvB,UAAa;QAEb,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,eAAe;gBAClB,OAAO;oBACL,MAAM,EAAG,cAAgC,CAAC,MAAM;oBAChD,OAAO,EAAG,cAAgC,CAAC,OAAO;iBACxB,CAAC;YAC/B,KAAK,eAAe;gBAClB,OAAO;oBACL,OAAO,EAAG,cAAgC,CAAC,OAAO;iBACxB,CAAC;YAC/B,4EAA4E;YAC5E,KAAK,YAAY,CAAC;YAClB;gBACE,OAAO,cAAyC,CAAC;QACrD,CAAC;IACH,CAAC;CACF;AA1FD,oCA0FC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/** biome-ignore-all lint/complexity/noBannedTypes: needed for conditional props */
|
|
1
2
|
import { ZodObject, ZodRawShape } from 'zod';
|
|
2
3
|
export type SearchDepth = 'standard' | 'deep';
|
|
3
4
|
export type SearchOutputType = 'sourcedAnswer' | 'searchResults' | 'structured';
|
|
@@ -17,6 +18,7 @@ export interface SearchParams<T extends SearchOutputType> {
|
|
|
17
18
|
excludeDomains?: string[];
|
|
18
19
|
fromDate?: Date;
|
|
19
20
|
toDate?: Date;
|
|
21
|
+
includeInlineCitations?: boolean;
|
|
20
22
|
}
|
|
21
23
|
export type LinkupSearchResponse<T> = T extends 'sourcedAnswer' ? SourcedAnswer : T extends 'searchResults' ? SearchResults : T extends 'structured' ? StructuredOutputSchema : never;
|
|
22
24
|
export interface SearchResults {
|
|
@@ -57,10 +59,15 @@ export interface FetchParams {
|
|
|
57
59
|
url: string;
|
|
58
60
|
renderJs?: boolean;
|
|
59
61
|
includeRawHtml?: boolean;
|
|
62
|
+
extractImages?: boolean;
|
|
60
63
|
}
|
|
64
|
+
type ConditionalProp<Condition, PropType> = Condition extends true ? PropType : {};
|
|
61
65
|
export type LinkupFetchResponse<T extends FetchParams = FetchParams> = {
|
|
62
66
|
markdown: string;
|
|
63
|
-
} &
|
|
67
|
+
} & ConditionalProp<T['includeRawHtml'], {
|
|
64
68
|
rawHtml: string;
|
|
65
|
-
}
|
|
69
|
+
}> & ConditionalProp<T['extractImages'], {
|
|
70
|
+
images: string[];
|
|
71
|
+
}>;
|
|
72
|
+
export {};
|
|
66
73
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,eAAe,GAAG,YAAY,CAAC;AAEhF,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7D,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAE1F,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,gBAAgB;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,WAAW,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sBAAsB,CAAC,EAAE,2BAA2B,CAAC;IACrD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,eAAe,GAAG,YAAY,CAAC;AAEhF,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7D,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAE1F,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,gBAAgB;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,WAAW,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sBAAsB,CAAC,EAAE,2BAA2B,CAAC;IACrD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC3D,aAAa,GACb,CAAC,SAAS,eAAe,GACvB,aAAa,GACb,CAAC,SAAS,YAAY,GACpB,sBAAsB,GACtB,KAAK,CAAC;AAEd,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;CACnD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,MAAM,GAAG,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,CAAC;SACjB,EAAE,CAAC;KACL,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,KAAK,eAAe,CAAC,SAAS,EAAE,QAAQ,IAAI,SAAS,SAAS,IAAI,GAAG,QAAQ,GAAG,EAAE,CAAC;AAEnF,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACrE,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,EAAE;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,GAC3D,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE;IAAE,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAAC"}
|