exa-js 1.10.1 → 2.0.0

package/dist/index.mjs

@@ -4,7 +4,7 @@ import fetch2, { Headers } from "cross-fetch";
 // package.json
 var package_default = {
   name: "exa-js",
-  version: "1.10.1",
+  version: "2.0.0",
   description: "Exa SDK for Node.js and the browser",
   publishConfig: {
     access: "public"
@@ -28,8 +28,9 @@ var package_default = {
     "build-fast": "tsup src/index.ts --format cjs,esm",
     build: "tsup",
     test: "vitest run",
+    "test:unit": "vitest run --config vitest.unit.config.ts",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
     typecheck: "tsc --noEmit",
-    "typecheck:src": "tsc --noEmit src/**/*.ts",
     "typecheck:examples": "tsc --noEmit examples/**/*.ts",
     "generate:types:websets": "openapi-typescript https://raw.githubusercontent.com/exa-labs/openapi-spec/refs/heads/master/exa-websets-spec.yaml  --enum --root-types --alphabetize --root-types-no-schema-prefix --output ./src/websets/openapi.ts && npm run format:websets",
     format: 'prettier --write "src/**/*.ts" "examples/**/*.ts"',
@@ -168,7 +169,7 @@ var ResearchClient = class extends ResearchBaseClient {
     }
     const payload = {
       instructions,
-      model: model ?? "exa-research"
+      model: model ?? "exa-research-fast"
     };
     if (schema) {
       payload.outputSchema = schema;
@@ -1259,6 +1260,7 @@ var WebsetsClient = class extends WebsetsBaseClient {
 // src/index.ts
 var fetchImpl = typeof global !== "undefined" && global.fetch ? global.fetch : fetch2;
 var HeadersImpl = typeof global !== "undefined" && global.Headers ? global.Headers : Headers;
+var DEFAULT_MAX_CHARACTERS = 1e4;
 var Exa2 = class {
   /**
    * Helper method to separate out the contents-specific options from the rest.
@@ -1266,7 +1268,6 @@ var Exa2 = class {
   extractContentsOptions(options) {
     const {
       text,
-      highlights,
       summary,
       subpages,
       subpageTarget,
@@ -1277,7 +1278,7 @@ var Exa2 = class {
       ...rest
     } = options;
     const contentsOptions = {};
-    if (text === void 0 && summary === void 0 && highlights === void 0 && extras === void 0) {
+    if (text === void 0 && summary === void 0 && extras === void 0) {
       contentsOptions.text = true;
     }
     if (text !== void 0) contentsOptions.text = text;
@@ -1291,7 +1292,6 @@ var Exa2 = class {
         contentsOptions.summary = summary;
       }
     }
-    if (highlights !== void 0) contentsOptions.highlights = highlights;
     if (subpages !== void 0) contentsOptions.subpages = subpages;
     if (subpageTarget !== void 0)
       contentsOptions.subpageTarget = subpageTarget;
@@ -1313,10 +1313,10 @@ var Exa2 = class {
   constructor(apiKey, baseURL = "https://api.exa.ai") {
     this.baseURL = baseURL;
     if (!apiKey) {
-      apiKey = process.env.EXASEARCH_API_KEY;
+      apiKey = process.env.EXA_API_KEY;
       if (!apiKey) {
         throw new ExaError(
-          "API key must be provided as an argument or as an environment variable (EXASEARCH_API_KEY)",
+          "API key must be provided as an argument or as an environment variable (EXA_API_KEY)",
           401 /* Unauthorized */
         );
       }
@@ -1419,17 +1419,28 @@ var Exa2 = class {
     });
     return response;
   }
-  /**
-   * Performs a search with an Exa prompt-engineered query.
-   *
-   * @param {string} query - The query string.
-   * @param {RegularSearchOptions} [options] - Additional search options
-   * @returns {Promise<SearchResponse<{}>>} A list of relevant search results.
-   */
   async search(query, options) {
+    if (options === void 0 || !("contents" in options)) {
+      return await this.request("/search", "POST", {
+        query,
+        ...options,
+        contents: { text: { maxCharacters: DEFAULT_MAX_CHARACTERS } }
+      });
+    }
+    if (options.contents === false || options.contents === null || options.contents === void 0) {
+      const { contents, ...restOptions } = options;
+      return await this.request("/search", "POST", { query, ...restOptions });
+    }
     return await this.request("/search", "POST", { query, ...options });
   }
   /**
+   * @deprecated Use `search()` instead. The search method now returns text contents by default.
+   *
+   * Migration examples:
+   * - `searchAndContents(query)` → `search(query)`
+   * - `searchAndContents(query, { text: true })` → `search(query, { contents: { text: true } })`
+   * - `searchAndContents(query, { summary: true })` → `search(query, { contents: { summary: true } })`
+   *
    * Performs a search with an Exa prompt-engineered query and returns the contents of the documents.
    *
    * @param {string} query - The query string.
@@ -1437,30 +1448,55 @@ var Exa2 = class {
    * @returns {Promise<SearchResponse<T>>} A list of relevant search results with requested contents.
    */
   async searchAndContents(query, options) {
-    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
+    const { contentsOptions, restOptions } = options === void 0 ? {
+      contentsOptions: {
+        text: { maxCharacters: DEFAULT_MAX_CHARACTERS }
+      },
+      restOptions: {}
+    } : this.extractContentsOptions(options);
     return await this.request("/search", "POST", {
       query,
       contents: contentsOptions,
       ...restOptions
     });
   }
-  /**
-   * Finds similar links to the provided URL.
-   * @param {string} url - The URL for which to find similar links.
-   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.
-   * @returns {Promise<SearchResponse<{}>>} A list of similar search results.
-   */
   async findSimilar(url, options) {
+    if (options === void 0 || !("contents" in options)) {
+      return await this.request("/findSimilar", "POST", {
+        url,
+        ...options,
+        contents: { text: { maxCharacters: DEFAULT_MAX_CHARACTERS } }
+      });
+    }
+    if (options.contents === false || options.contents === null || options.contents === void 0) {
+      const { contents, ...restOptions } = options;
+      return await this.request("/findSimilar", "POST", {
+        url,
+        ...restOptions
+      });
+    }
     return await this.request("/findSimilar", "POST", { url, ...options });
   }
   /**
+   * @deprecated Use `findSimilar()` instead. The findSimilar method now returns text contents by default.
+   *
+   * Migration examples:
+   * - `findSimilarAndContents(url)` → `findSimilar(url)`
+   * - `findSimilarAndContents(url, { text: true })` → `findSimilar(url, { contents: { text: true } })`
+   * - `findSimilarAndContents(url, { summary: true })` → `findSimilar(url, { contents: { summary: true } })`
+   *
    * Finds similar links to the provided URL and returns the contents of the documents.
    * @param {string} url - The URL for which to find similar links.
    * @param {FindSimilarOptions & T} [options] - Additional options for finding similar links + contents.
    * @returns {Promise<SearchResponse<T>>} A list of similar search results, including requested contents.
    */
   async findSimilarAndContents(url, options) {
-    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
+    const { contentsOptions, restOptions } = options === void 0 ? {
+      contentsOptions: {
+        text: { maxCharacters: DEFAULT_MAX_CHARACTERS }
+      },
+      restOptions: {}
+    } : this.extractContentsOptions(options);
     return await this.request("/findSimilar", "POST", {
       url,
       contents: contentsOptions,