linkup-sdk 2.0.0 → 2.1.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 +6 -5
- package/dist/linkup-client.d.ts +2 -2
- package/dist/linkup-client.d.ts.map +1 -1
- package/dist/linkup-client.js.map +1 -1
- package/dist/types.d.ts +6 -2
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -73,9 +73,11 @@ askLinkup()
|
|
|
73
73
|
|
|
74
74
|
### ⬇️ Fetch Endpoint
|
|
75
75
|
|
|
76
|
-
You can use the fetch endpoint to retrieve the content of a given URL
|
|
76
|
+
You can use the fetch endpoint to retrieve the content of a given URL in clean `markdown` format.
|
|
77
77
|
|
|
78
|
-
You can also use the `
|
|
78
|
+
You can also use the `renderJs` flag to execute the JavaScript code of the page before returning the content.
|
|
79
|
+
|
|
80
|
+
You can also ask to `includeRawHtml` if you feel like it.
|
|
79
81
|
|
|
80
82
|
#### 📝 Example
|
|
81
83
|
|
|
@@ -87,9 +89,8 @@ const client = new LinkupClient({
|
|
|
87
89
|
});
|
|
88
90
|
|
|
89
91
|
const fetchLinkup = async () => client.fetch({
|
|
90
|
-
url: 'https://
|
|
91
|
-
|
|
92
|
-
renderJS: true,
|
|
92
|
+
url: 'https://docs.linkup.so',
|
|
93
|
+
renderJs: true,
|
|
93
94
|
});
|
|
94
95
|
|
|
95
96
|
fetchLinkup()
|
package/dist/linkup-client.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { ApiConfig, FetchParams, SearchParams, SearchResults, SourcedAnswer, StructuredOutputSchema } from './types';
|
|
1
|
+
import { ApiConfig, FetchParams, LinkupFetchResponse, SearchParams, SearchResults, SourcedAnswer, StructuredOutputSchema } from './types';
|
|
2
2
|
export declare class LinkupClient {
|
|
3
3
|
private readonly USER_AGENT;
|
|
4
4
|
private readonly client;
|
|
5
5
|
constructor(config: ApiConfig);
|
|
6
6
|
search<T extends 'sourcedAnswer' | 'searchResults' | 'structured'>(params: SearchParams<T>): Promise<T extends 'sourcedAnswer' ? SourcedAnswer : T extends 'searchResults' ? SearchResults : T extends 'structured' ? StructuredOutputSchema : never>;
|
|
7
|
-
fetch(params: FetchParams): Promise<
|
|
7
|
+
fetch(params: FetchParams): Promise<LinkupFetchResponse>;
|
|
8
8
|
private sanitizeParams;
|
|
9
9
|
private formatResponse;
|
|
10
10
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkup-client.d.ts","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,WAAW,
|
|
1
|
+
{"version":3,"file":"linkup-client.d.ts","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,WAAW,EACX,mBAAmB,EAGnB,YAAY,EACZ,aAAa,EACb,aAAa,EACb,sBAAsB,EACvB,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,eAAe,GAAG,eAAe,GAAG,YAAY,EACrE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,OAAO,CACR,CAAC,SAAS,eAAe,GACrB,aAAa,GACb,CAAC,SAAS,eAAe,GACvB,aAAa,GACb,CAAC,SAAS,YAAY,GACpB,sBAAsB,GACtB,KAAK,CACd;IAMK,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAI9D,OAAO,CAAC,cAAc;IA8BtB,OAAO,CAAC,cAAc;CAoBvB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkup-client.js","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAE7C,4EAAiD;
|
|
1
|
+
{"version":3,"file":"linkup-client.js","sourceRoot":"","sources":["../src/linkup-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAE7C,4EAAiD;AAYjD,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;QAUvB,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,CAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAmB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAsB,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjG,CAAC;IAEO,cAAc,CAA6B,EACjD,KAAK,EACL,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,cAAc,EACd,QAAQ,EACR,MAAM,GACU;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;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,UAA4B;QAE5B,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;AAhGD,oCAgGC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -54,7 +54,11 @@ export type LinkupApiError = {
|
|
|
54
54
|
};
|
|
55
55
|
export interface FetchParams {
|
|
56
56
|
url: string;
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
renderJs?: boolean;
|
|
58
|
+
includeRawHtml?: boolean;
|
|
59
|
+
}
|
|
60
|
+
export interface LinkupFetchResponse {
|
|
61
|
+
markdown: string;
|
|
62
|
+
rawHtml?: string;
|
|
59
63
|
}
|
|
60
64
|
//# 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,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAEtF,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,sBAAsB,CAAC;IAChD,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;CACf;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,
|
|
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,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAEtF,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,sBAAsB,CAAC;IAChD,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;CACf;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;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "linkup-sdk",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"scripts": {
|
|
@@ -39,19 +39,19 @@
|
|
|
39
39
|
],
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@biomejs/biome": "2.0.5",
|
|
42
|
+
"@commitlint/cli": "^19.8.1",
|
|
43
|
+
"@commitlint/config-conventional": "^19.8.1",
|
|
42
44
|
"@types/jest": "^29.5.14",
|
|
43
45
|
"@types/node": "^24.0.4",
|
|
44
46
|
"husky": "^9.1.7",
|
|
45
47
|
"jest": "^29.7.0",
|
|
46
48
|
"knip": "^5.61.2",
|
|
49
|
+
"semantic-release": "^24.2.5",
|
|
47
50
|
"ts-jest": "^29.2.5",
|
|
48
51
|
"typescript": "^5.8.3"
|
|
49
52
|
},
|
|
50
53
|
"dependencies": {
|
|
51
|
-
"@commitlint/cli": "^19.8.1",
|
|
52
|
-
"@commitlint/config-conventional": "^19.8.1",
|
|
53
54
|
"axios": "^1.8.2",
|
|
54
|
-
"semantic-release": "^24.2.5",
|
|
55
55
|
"zod": "^3.24.1",
|
|
56
56
|
"zod-to-json-schema": "^3.24.1"
|
|
57
57
|
},
|