exa-js 1.9.0 → 1.9.2

package/dist/index.js

@@ -32,10 +32,6 @@ var index_exports = {};
 __export(index_exports, {
   CreateEnrichmentParametersFormat: () => CreateEnrichmentParametersFormat,
   CreateImportParametersFormat: () => CreateImportParametersFormat,
-  CreateWebsetParametersImportSource: () => CreateWebsetParametersImportSource,
-  CreateWebsetParametersSearchExcludeSource: () => CreateWebsetParametersSearchExcludeSource,
-  CreateWebsetSearchParametersExcludeSource: () => CreateWebsetSearchParametersExcludeSource,
-  CreateWebsetSearchParametersScopeSource: () => CreateWebsetSearchParametersScopeSource,
   EventType: () => EventType,
   EventsClient: () => EventsClient,
   Exa: () => Exa2,
@@ -51,19 +47,20 @@ __export(index_exports, {
   MonitorRunStatus: () => MonitorRunStatus,
   MonitorRunType: () => MonitorRunType,
   MonitorStatus: () => MonitorStatus,
-  PreviewWebsetResponseEnrichmentsFormat: () => PreviewWebsetResponseEnrichmentsFormat,
-  ScopeSourceType: () => ScopeSourceType,
   UpdateMonitorStatus: () => UpdateMonitorStatus,
   WebhookStatus: () => WebhookStatus,
   WebsetEnrichmentFormat: () => WebsetEnrichmentFormat,
   WebsetEnrichmentStatus: () => WebsetEnrichmentStatus,
   WebsetEnrichmentsClient: () => WebsetEnrichmentsClient,
+  WebsetImportSource: () => WebsetImportSource,
   WebsetItemEvaluationSatisfied: () => WebsetItemEvaluationSatisfied,
   WebsetItemSource: () => WebsetItemSource,
   WebsetItemsClient: () => WebsetItemsClient,
   WebsetMonitorsClient: () => WebsetMonitorsClient,
   WebsetSearchBehavior: () => WebsetSearchBehavior,
   WebsetSearchCanceledReason: () => WebsetSearchCanceledReason,
+  WebsetSearchExcludeSource: () => WebsetSearchExcludeSource,
+  WebsetSearchScopeSource: () => WebsetSearchScopeSource,
   WebsetSearchStatus: () => WebsetSearchStatus,
   WebsetSearchesClient: () => WebsetSearchesClient,
   WebsetStatus: () => WebsetStatus,
@@ -74,6 +71,89 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 var import_cross_fetch = __toESM(require("cross-fetch"));
 
+// package.json
+var package_default = {
+  name: "exa-js",
+  version: "1.9.2",
+  description: "Exa SDK for Node.js and the browser",
+  publishConfig: {
+    access: "public"
+  },
+  files: [
+    "dist"
+  ],
+  main: "./dist/index.js",
+  module: "./dist/index.mjs",
+  exports: {
+    ".": {
+      types: "./dist/index.d.ts",
+      require: "./dist/index.js",
+      module: "./dist/index.mjs",
+      import: "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  types: "./dist/index.d.ts",
+  scripts: {
+    "build-fast": "tsup src/index.ts --format cjs,esm",
+    build: "tsup",
+    test: "vitest run",
+    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"',
+    "format:websets": "prettier --write src/websets/openapi.ts",
+    "build:beta": "cross-env NPM_CONFIG_TAG=beta npm run build",
+    "version:beta": "npm version prerelease --preid=beta",
+    "version:stable": "npm version patch",
+    "publish:beta": "npm run version:beta && npm run build:beta && npm publish --tag beta",
+    "publish:stable": "npm run version:stable && npm run build && npm publish",
+    prepublishOnly: "npm run build"
+  },
+  license: "MIT",
+  devDependencies: {
+    "@types/node": "~22.14.0",
+    "cross-env": "~7.0.3",
+    "openapi-typescript": "~7.6.1",
+    prettier: "~3.5.3",
+    "ts-node": "~10.9.2",
+    tsup: "~8.4.0",
+    typescript: "~5.8.3",
+    vitest: "~3.1.1"
+  },
+  dependencies: {
+    "cross-fetch": "~4.1.0",
+    dotenv: "~16.4.7",
+    openai: "^5.0.1",
+    zod: "^3.22.0",
+    "zod-to-json-schema": "^3.20.0"
+  },
+  directories: {
+    test: "test"
+  },
+  repository: {
+    type: "git",
+    url: "git+https://github.com/exa-labs/exa-js.git"
+  },
+  keywords: [
+    "exa",
+    "metaphor",
+    "search",
+    "AI",
+    "LLMs",
+    "RAG",
+    "retrieval",
+    "augmented",
+    "generation"
+  ],
+  author: "jeffzwang",
+  bugs: {
+    url: "https://github.com/exa-labs/exa-js/issues"
+  },
+  homepage: "https://github.com/exa-labs/exa-js#readme"
+};
+
 // src/errors.ts
 var HttpStatusCode = /* @__PURE__ */ ((HttpStatusCode2) => {
   HttpStatusCode2[HttpStatusCode2["BadRequest"] = 400] = "BadRequest";
@@ -103,6 +183,173 @@ var ExaError = class extends Error {
   }
 };
 
+// src/zod-utils.ts
+var import_zod = require("zod");
+var import_zod_to_json_schema = require("zod-to-json-schema");
+function isZodSchema(obj) {
+  return obj instanceof import_zod.ZodType;
+}
+function zodToJsonSchema(schema) {
+  return (0, import_zod_to_json_schema.zodToJsonSchema)(schema, {
+    $refStrategy: "none"
+  });
+}
+
+// src/research/base.ts
+var ResearchBaseClient = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async request(endpoint, method = "POST", data, params) {
+    return this.client.request(
+      `/research/v1${endpoint}`,
+      method,
+      data,
+      params
+    );
+  }
+  async rawRequest(endpoint, method = "POST", data, params) {
+    return this.client.rawRequest(
+      `/research/v1${endpoint}`,
+      method,
+      data,
+      params
+    );
+  }
+  buildPaginationParams(pagination) {
+    const params = {};
+    if (!pagination) return params;
+    if (pagination.cursor) params.cursor = pagination.cursor;
+    if (pagination.limit) params.limit = pagination.limit;
+    return params;
+  }
+};
+
+// src/research/client.ts
+var ResearchClient = class extends ResearchBaseClient {
+  constructor(client) {
+    super(client);
+  }
+  async create(params) {
+    const { instructions, model, outputSchema } = params;
+    let schema = outputSchema;
+    if (schema && isZodSchema(schema)) {
+      schema = zodToJsonSchema(schema);
+    }
+    const payload = {
+      instructions,
+      model: model ?? "exa-research"
+    };
+    if (schema) {
+      payload.outputSchema = schema;
+    }
+    return this.request("", "POST", payload);
+  }
+  get(researchId, options) {
+    if (options?.stream) {
+      const promise = async () => {
+        const params = { stream: "true" };
+        if (options.events !== void 0) {
+          params.events = options.events.toString();
+        }
+        const resp = await this.rawRequest(
+          `/${researchId}`,
+          "GET",
+          void 0,
+          params
+        );
+        if (!resp.body) {
+          throw new Error("No response body for SSE stream");
+        }
+        const reader = resp.body.getReader();
+        const decoder = new TextDecoder();
+        let buffer = "";
+        function processPart(part) {
+          const lines = part.split("\n");
+          let data = lines.slice(1).join("\n");
+          if (data.startsWith("data:")) {
+            data = data.slice(5).trimStart();
+          }
+          try {
+            return JSON.parse(data);
+          } catch (e) {
+            return null;
+          }
+        }
+        async function* streamEvents() {
+          while (true) {
+            const { done, value } = await reader.read();
+            if (done) break;
+            buffer += decoder.decode(value, { stream: true });
+            let parts = buffer.split("\n\n");
+            buffer = parts.pop() ?? "";
+            for (const part of parts) {
+              const processed = processPart(part);
+              if (processed) {
+                yield processed;
+              }
+            }
+          }
+          if (buffer.trim()) {
+            const processed = processPart(buffer.trim());
+            if (processed) {
+              yield processed;
+            }
+          }
+        }
+        return streamEvents();
+      };
+      return promise();
+    } else {
+      const params = { stream: "false" };
+      if (options?.events !== void 0) {
+        params.events = options.events.toString();
+      }
+      return this.request(
+        `/${researchId}`,
+        "GET",
+        void 0,
+        params
+      );
+    }
+  }
+  async list(options) {
+    const params = this.buildPaginationParams(options);
+    return this.request("", "GET", void 0, params);
+  }
+  async pollUntilFinished(researchId, options) {
+    const pollInterval = options?.pollInterval ?? 1e3;
+    const timeoutMs = options?.timeoutMs ?? 10 * 60 * 1e3;
+    const maxConsecutiveFailures = 5;
+    const startTime = Date.now();
+    let consecutiveFailures = 0;
+    while (true) {
+      try {
+        const research = await this.get(researchId, {
+          events: options?.events
+        });
+        consecutiveFailures = 0;
+        if (research.status === "completed" || research.status === "failed" || research.status === "canceled") {
+          return research;
+        }
+      } catch (err) {
+        consecutiveFailures += 1;
+        if (consecutiveFailures >= maxConsecutiveFailures) {
+          throw new Error(
+            `Polling failed ${maxConsecutiveFailures} times in a row for research ${researchId}: ${err}`
+          );
+        }
+      }
+      if (Date.now() - startTime > timeoutMs) {
+        throw new Error(
+          `Polling timeout: Research ${researchId} did not complete within ${timeoutMs}ms`
+        );
+      }
+      await new Promise((resolve) => setTimeout(resolve, pollInterval));
+    }
+  }
+};
+
 // src/websets/base.ts
 var WebsetsBaseClient = class {
   /**
@@ -183,6 +430,20 @@ var WebsetEnrichmentsClient = class extends WebsetsBaseClient {
       "DELETE"
     );
   }
+  /**
+   * Update an Enrichment
+   * @param websetId The ID of the Webset
+   * @param id The ID of the Enrichment
+   * @param params The enrichment update parameters
+   * @returns Promise that resolves when the update is complete
+   */
+  async update(websetId, id, params) {
+    return this.request(
+      `/v0/websets/${websetId}/enrichments/${id}`,
+      "PATCH",
+      params
+    );
+  }
   /**
    * Cancel a running Enrichment
    * @param websetId The ID of the Webset
@@ -242,37 +503,18 @@ var CreateEnrichmentParametersFormat = /* @__PURE__ */ ((CreateEnrichmentParamet
   CreateEnrichmentParametersFormat2["options"] = "options";
   CreateEnrichmentParametersFormat2["email"] = "email";
   CreateEnrichmentParametersFormat2["phone"] = "phone";
+  CreateEnrichmentParametersFormat2["url"] = "url";
   return CreateEnrichmentParametersFormat2;
 })(CreateEnrichmentParametersFormat || {});
 var CreateImportParametersFormat = /* @__PURE__ */ ((CreateImportParametersFormat2) => {
   CreateImportParametersFormat2["csv"] = "csv";
   return CreateImportParametersFormat2;
 })(CreateImportParametersFormat || {});
-var CreateWebsetParametersImportSource = /* @__PURE__ */ ((CreateWebsetParametersImportSource2) => {
-  CreateWebsetParametersImportSource2["import"] = "import";
-  CreateWebsetParametersImportSource2["webset"] = "webset";
-  return CreateWebsetParametersImportSource2;
-})(CreateWebsetParametersImportSource || {});
-var CreateWebsetParametersSearchExcludeSource = /* @__PURE__ */ ((CreateWebsetParametersSearchExcludeSource2) => {
-  CreateWebsetParametersSearchExcludeSource2["import"] = "import";
-  CreateWebsetParametersSearchExcludeSource2["webset"] = "webset";
-  return CreateWebsetParametersSearchExcludeSource2;
-})(CreateWebsetParametersSearchExcludeSource || {});
-var ScopeSourceType = /* @__PURE__ */ ((ScopeSourceType2) => {
-  ScopeSourceType2["import"] = "import";
-  ScopeSourceType2["webset"] = "webset";
-  return ScopeSourceType2;
-})(ScopeSourceType || {});
-var CreateWebsetSearchParametersExcludeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersExcludeSource2) => {
-  CreateWebsetSearchParametersExcludeSource2["import"] = "import";
-  CreateWebsetSearchParametersExcludeSource2["webset"] = "webset";
-  return CreateWebsetSearchParametersExcludeSource2;
-})(CreateWebsetSearchParametersExcludeSource || {});
-var CreateWebsetSearchParametersScopeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersScopeSource2) => {
-  CreateWebsetSearchParametersScopeSource2["import"] = "import";
-  CreateWebsetSearchParametersScopeSource2["webset"] = "webset";
-  return CreateWebsetSearchParametersScopeSource2;
-})(CreateWebsetSearchParametersScopeSource || {});
+var WebsetImportSource = /* @__PURE__ */ ((WebsetImportSource2) => {
+  WebsetImportSource2["import"] = "import";
+  WebsetImportSource2["webset"] = "webset";
+  return WebsetImportSource2;
+})(WebsetImportSource || {});
 var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_created"] = "webset.created";
   EventType2["webset_deleted"] = "webset.deleted";
@@ -284,9 +526,13 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_search_updated"] = "webset.search.updated";
   EventType2["import_created"] = "import.created";
   EventType2["import_completed"] = "import.completed";
-  EventType2["import_processing"] = "import.processing";
   EventType2["webset_item_created"] = "webset.item.created";
   EventType2["webset_item_enriched"] = "webset.item.enriched";
+  EventType2["monitor_created"] = "monitor.created";
+  EventType2["monitor_updated"] = "monitor.updated";
+  EventType2["monitor_deleted"] = "monitor.deleted";
+  EventType2["monitor_run_created"] = "monitor.run.created";
+  EventType2["monitor_run_completed"] = "monitor.run.completed";
   EventType2["webset_export_created"] = "webset.export.created";
   EventType2["webset_export_completed"] = "webset.export.completed";
   return EventType2;
@@ -339,15 +585,6 @@ var MonitorRunType = /* @__PURE__ */ ((MonitorRunType2) => {
   MonitorRunType2["refresh"] = "refresh";
   return MonitorRunType2;
 })(MonitorRunType || {});
-var PreviewWebsetResponseEnrichmentsFormat = /* @__PURE__ */ ((PreviewWebsetResponseEnrichmentsFormat2) => {
-  PreviewWebsetResponseEnrichmentsFormat2["text"] = "text";
-  PreviewWebsetResponseEnrichmentsFormat2["date"] = "date";
-  PreviewWebsetResponseEnrichmentsFormat2["number"] = "number";
-  PreviewWebsetResponseEnrichmentsFormat2["options"] = "options";
-  PreviewWebsetResponseEnrichmentsFormat2["email"] = "email";
-  PreviewWebsetResponseEnrichmentsFormat2["phone"] = "phone";
-  return PreviewWebsetResponseEnrichmentsFormat2;
-})(PreviewWebsetResponseEnrichmentsFormat || {});
 var UpdateMonitorStatus = /* @__PURE__ */ ((UpdateMonitorStatus2) => {
   UpdateMonitorStatus2["enabled"] = "enabled";
   UpdateMonitorStatus2["disabled"] = "disabled";
@@ -378,6 +615,7 @@ var WebsetEnrichmentFormat = /* @__PURE__ */ ((WebsetEnrichmentFormat2) => {
   WebsetEnrichmentFormat2["options"] = "options";
   WebsetEnrichmentFormat2["email"] = "email";
   WebsetEnrichmentFormat2["phone"] = "phone";
+  WebsetEnrichmentFormat2["url"] = "url";
   return WebsetEnrichmentFormat2;
 })(WebsetEnrichmentFormat || {});
 var WebsetItemSource = /* @__PURE__ */ ((WebsetItemSource2) => {
@@ -391,6 +629,16 @@ var WebsetItemEvaluationSatisfied = /* @__PURE__ */ ((WebsetItemEvaluationSatisf
   WebsetItemEvaluationSatisfied2["unclear"] = "unclear";
   return WebsetItemEvaluationSatisfied2;
 })(WebsetItemEvaluationSatisfied || {});
+var WebsetSearchExcludeSource = /* @__PURE__ */ ((WebsetSearchExcludeSource2) => {
+  WebsetSearchExcludeSource2["import"] = "import";
+  WebsetSearchExcludeSource2["webset"] = "webset";
+  return WebsetSearchExcludeSource2;
+})(WebsetSearchExcludeSource || {});
+var WebsetSearchScopeSource = /* @__PURE__ */ ((WebsetSearchScopeSource2) => {
+  WebsetSearchScopeSource2["import"] = "import";
+  WebsetSearchScopeSource2["webset"] = "webset";
+  return WebsetSearchScopeSource2;
+})(WebsetSearchScopeSource || {});
 var WebsetSearchStatus = /* @__PURE__ */ ((WebsetSearchStatus2) => {
   WebsetSearchStatus2["created"] = "created";
   WebsetSearchStatus2["pending"] = "pending";
@@ -1078,173 +1326,6 @@ var WebsetsClient = class extends WebsetsBaseClient {
   }
 };
 
-// src/zod-utils.ts
-var import_zod = require("zod");
-var import_zod_to_json_schema = require("zod-to-json-schema");
-function isZodSchema(obj) {
-  return obj instanceof import_zod.ZodType;
-}
-function zodToJsonSchema(schema) {
-  return (0, import_zod_to_json_schema.zodToJsonSchema)(schema, {
-    $refStrategy: "none"
-  });
-}
-
-// src/research/base.ts
-var ResearchBaseClient = class {
-  constructor(client) {
-    this.client = client;
-  }
-  async request(endpoint, method = "POST", data, params) {
-    return this.client.request(
-      `/research/v1${endpoint}`,
-      method,
-      data,
-      params
-    );
-  }
-  async rawRequest(endpoint, method = "POST", data, params) {
-    return this.client.rawRequest(
-      `/research/v1${endpoint}`,
-      method,
-      data,
-      params
-    );
-  }
-  buildPaginationParams(pagination) {
-    const params = {};
-    if (!pagination) return params;
-    if (pagination.cursor) params.cursor = pagination.cursor;
-    if (pagination.limit) params.limit = pagination.limit;
-    return params;
-  }
-};
-
-// src/research/client.ts
-var ResearchClient = class extends ResearchBaseClient {
-  constructor(client) {
-    super(client);
-  }
-  async create(params) {
-    const { instructions, model, outputSchema } = params;
-    let schema = outputSchema;
-    if (schema && isZodSchema(schema)) {
-      schema = zodToJsonSchema(schema);
-    }
-    const payload = {
-      instructions,
-      model: model ?? "exa-research"
-    };
-    if (schema) {
-      payload.outputSchema = schema;
-    }
-    return this.request("", "POST", payload);
-  }
-  get(researchId, options) {
-    if (options?.stream) {
-      const promise = async () => {
-        const params = { stream: "true" };
-        if (options.events !== void 0) {
-          params.events = options.events.toString();
-        }
-        const resp = await this.rawRequest(
-          `/${researchId}`,
-          "GET",
-          void 0,
-          params
-        );
-        if (!resp.body) {
-          throw new Error("No response body for SSE stream");
-        }
-        const reader = resp.body.getReader();
-        const decoder = new TextDecoder();
-        let buffer = "";
-        function processPart(part) {
-          const lines = part.split("\n");
-          let data = lines.slice(1).join("\n");
-          if (data.startsWith("data:")) {
-            data = data.slice(5).trimStart();
-          }
-          try {
-            return JSON.parse(data);
-          } catch (e) {
-            return null;
-          }
-        }
-        async function* streamEvents() {
-          while (true) {
-            const { done, value } = await reader.read();
-            if (done) break;
-            buffer += decoder.decode(value, { stream: true });
-            let parts = buffer.split("\n\n");
-            buffer = parts.pop() ?? "";
-            for (const part of parts) {
-              const processed = processPart(part);
-              if (processed) {
-                yield processed;
-              }
-            }
-          }
-          if (buffer.trim()) {
-            const processed = processPart(buffer.trim());
-            if (processed) {
-              yield processed;
-            }
-          }
-        }
-        return streamEvents();
-      };
-      return promise();
-    } else {
-      const params = { stream: "false" };
-      if (options?.events !== void 0) {
-        params.events = options.events.toString();
-      }
-      return this.request(
-        `/${researchId}`,
-        "GET",
-        void 0,
-        params
-      );
-    }
-  }
-  async list(options) {
-    const params = this.buildPaginationParams(options);
-    return this.request("", "GET", void 0, params);
-  }
-  async pollUntilFinished(researchId, options) {
-    const pollInterval = options?.pollInterval ?? 1e3;
-    const timeoutMs = options?.timeoutMs ?? 10 * 60 * 1e3;
-    const maxConsecutiveFailures = 5;
-    const startTime = Date.now();
-    let consecutiveFailures = 0;
-    while (true) {
-      try {
-        const research = await this.get(researchId, {
-          events: options?.events
-        });
-        consecutiveFailures = 0;
-        if (research.status === "completed" || research.status === "failed" || research.status === "canceled") {
-          return research;
-        }
-      } catch (err) {
-        consecutiveFailures += 1;
-        if (consecutiveFailures >= maxConsecutiveFailures) {
-          throw new Error(
-            `Polling failed ${maxConsecutiveFailures} times in a row for research ${researchId}: ${err}`
-          );
-        }
-      }
-      if (Date.now() - startTime > timeoutMs) {
-        throw new Error(
-          `Polling timeout: Research ${researchId} did not complete within ${timeoutMs}ms`
-        );
-      }
-      await new Promise((resolve) => setTimeout(resolve, pollInterval));
-    }
-  }
-};
-
 // src/index.ts
 var fetchImpl = typeof global !== "undefined" && global.fetch ? global.fetch : import_cross_fetch.default;
 var HeadersImpl = typeof global !== "undefined" && global.Headers ? global.Headers : import_cross_fetch.Headers;
@@ -1313,7 +1394,7 @@ var Exa2 = class {
     this.headers = new HeadersImpl({
       "x-api-key": apiKey,
       "Content-Type": "application/json",
-      "User-Agent": "exa-node 1.4.0"
+      "User-Agent": `exa-node ${package_default.version}`
     });
     this.websets = new WebsetsClient(this);
     this.research = new ResearchClient(this);
@@ -1673,10 +1754,6 @@ var index_default = Exa2;
 0 && (module.exports = {
   CreateEnrichmentParametersFormat,
   CreateImportParametersFormat,
-  CreateWebsetParametersImportSource,
-  CreateWebsetParametersSearchExcludeSource,
-  CreateWebsetSearchParametersExcludeSource,
-  CreateWebsetSearchParametersScopeSource,
   EventType,
   EventsClient,
   Exa,
@@ -1692,19 +1769,20 @@ var index_default = Exa2;
   MonitorRunStatus,
   MonitorRunType,
   MonitorStatus,
-  PreviewWebsetResponseEnrichmentsFormat,
-  ScopeSourceType,
   UpdateMonitorStatus,
   WebhookStatus,
   WebsetEnrichmentFormat,
   WebsetEnrichmentStatus,
   WebsetEnrichmentsClient,
+  WebsetImportSource,
   WebsetItemEvaluationSatisfied,
   WebsetItemSource,
   WebsetItemsClient,
   WebsetMonitorsClient,
   WebsetSearchBehavior,
   WebsetSearchCanceledReason,
+  WebsetSearchExcludeSource,
+  WebsetSearchScopeSource,
   WebsetSearchStatus,
   WebsetSearchesClient,
   WebsetStatus,