linkup-sdk 2.0.1 → 2.1.1
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 +3 -3
- package/dist/linkup-client.d.ts.map +1 -1
- package/dist/linkup-client.js +1 -1
- package/dist/linkup-client.js.map +1 -1
- package/dist/types.d.ts +10 -4
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
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,
|
|
1
|
+
import { ApiConfig, FetchParams, LinkupFetchResponse, LinkupSearchResponse, SearchOutputType, SearchParams } 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
|
-
search<T extends
|
|
7
|
-
fetch(params:
|
|
6
|
+
search<T extends SearchOutputType>(params: SearchParams<T>): Promise<LinkupSearchResponse<T>>;
|
|
7
|
+
fetch<T extends FetchParams>(params: T): Promise<LinkupFetchResponse<T>>;
|
|
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,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;IA8BtB,OAAO,CAAC,cAAc;CAoBvB"}
|
package/dist/linkup-client.js
CHANGED
|
@@ -9,7 +9,7 @@ const zod_to_json_schema_1 = __importDefault(require("zod-to-json-schema"));
|
|
|
9
9
|
const refine_error_utils_1 = require("./utils/refine-error.utils");
|
|
10
10
|
const schema_utils_1 = require("./utils/schema.utils");
|
|
11
11
|
class LinkupClient {
|
|
12
|
-
USER_AGENT = 'Linkup-JS-SDK/2.
|
|
12
|
+
USER_AGENT = 'Linkup-JS-SDK/2.1.1';
|
|
13
13
|
client;
|
|
14
14
|
constructor(config) {
|
|
15
15
|
const baseURL = config.baseUrl || 'https://api.linkup.so/v1';
|
|
@@ -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;
|
|
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,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,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;AAxFD,oCAwFC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -5,13 +5,14 @@ export interface ApiConfig {
|
|
|
5
5
|
apiKey: string;
|
|
6
6
|
baseUrl?: string;
|
|
7
7
|
}
|
|
8
|
-
export type StructuredOutputSchema = Record<string, unknown
|
|
8
|
+
export type StructuredOutputSchema = Record<string, unknown>;
|
|
9
|
+
export type StructuredOutputInputSchema = StructuredOutputSchema | ZodObject<ZodRawShape>;
|
|
9
10
|
export interface SearchParams<T extends SearchOutputType> {
|
|
10
11
|
query: string;
|
|
11
12
|
depth: SearchDepth;
|
|
12
13
|
outputType: T;
|
|
13
14
|
includeImages?: boolean;
|
|
14
|
-
structuredOutputSchema?:
|
|
15
|
+
structuredOutputSchema?: StructuredOutputInputSchema;
|
|
15
16
|
includeDomains?: string[];
|
|
16
17
|
excludeDomains?: string[];
|
|
17
18
|
fromDate?: Date;
|
|
@@ -54,7 +55,12 @@ export type LinkupApiError = {
|
|
|
54
55
|
};
|
|
55
56
|
export interface FetchParams {
|
|
56
57
|
url: string;
|
|
57
|
-
|
|
58
|
-
|
|
58
|
+
renderJs?: boolean;
|
|
59
|
+
includeRawHtml?: boolean;
|
|
59
60
|
}
|
|
61
|
+
export type LinkupFetchResponse<T extends FetchParams = FetchParams> = {
|
|
62
|
+
markdown: string;
|
|
63
|
+
} & (T['includeRawHtml'] extends true ? {
|
|
64
|
+
rawHtml: string;
|
|
65
|
+
} : Record<string, never>);
|
|
60
66
|
//# 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;
|
|
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;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,MAAM,mBAAmB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACrE,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,SAAS,IAAI,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC"}
|