exa-js 1.1.3 → 1.3.0

package/dist/index.d.ts

@@ -53,6 +53,9 @@ type RegularSearchOptions = BaseSearchOptions & {
 type FindSimilarOptions = BaseSearchOptions & {
     excludeSourceDomain?: boolean;
 };
+type ExtrasOptions = {
+    links: number;
+};
 /**
  * Search options for performing a search query.
  * @typedef {Object} ContentsOptions
@@ -62,6 +65,8 @@ type FindSimilarOptions = BaseSearchOptions & {
  * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is "never" for neural/auto search, "fallback" for keyword search.
  * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.
  * @property {boolean} [filterEmptyResults] - If true, filters out results with no contents. Default is true.
+ * @property {number} [subpages] - The number of subpages to return for each result, where each subpage is derived from an internal link for the result
+ * @property {ExtrasOptions} [extras] - Miscelleneous data for derived from resutls
  */
 type ContentsOptions = {
     text?: TextContentsOptions | true;
@@ -70,6 +75,9 @@ type ContentsOptions = {
     livecrawl?: LivecrawlOptions;
     livecrawlTimeout?: number;
     filterEmptyResults?: boolean;
+    subpages?: number;
+    subpageTarget?: string | string[];
+    extras?: ExtrasOptions;
 } & (typeof isBeta extends true ? {} : {});
 /**
  * Options for livecrawling contents
@@ -129,6 +137,22 @@ type HighlightsResponse = {
 type SummaryResponse = {
     summary: string;
 };
+/**
+ * @typedef {Object} ExtrasResponse
+ * @property {string[]} links - The links on the page of a result
+ */
+type ExtrasResponse = {
+    extras: {
+        links: string[];
+    };
+};
+/**
+ * @typedef {Object} SubpagesResponse
+ * @property {ContentsResultComponent<T extends ContentsOptions>} subpages - The links on the page of a result
+ */
+type SubpagesResponse<T extends ContentsOptions> = {
+    subpages: ContentsResultComponent<T>[];
+};
 type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;
 /**
  * @typedef {Object} ContentsResultComponent
@@ -136,10 +160,10 @@ type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;
  *
  * @template T - A type extending from 'ContentsOptions'.
  */
-type ContentsResultComponent<T extends ContentsOptions> = Default<(T["text"] extends object | true ? TextResponse : {}) & (T["highlights"] extends object | true ? HighlightsResponse : {}) & (T["summary"] extends object | true ? SummaryResponse : {}), TextResponse>;
+type ContentsResultComponent<T extends ContentsOptions> = Default<(T["text"] extends object | true ? TextResponse : {}) & (T["highlights"] extends object | true ? HighlightsResponse : {}) & (T["summary"] extends object | true ? SummaryResponse : {}) & (T["subpages"] extends number ? SubpagesResponse<T> : {}) & (T["extras"] extends object ? ExtrasResponse : {}), TextResponse>;
 /**
  * Represents a search result object.
- * @typedef {Object} Result
+ * @typedef {Object} SearchResult
  * @property {string} title - The title of the search result.
  * @property {string} url - The URL of the search result.
  * @property {string} [publishedDate] - The estimated creation date of the content.
@@ -147,13 +171,14 @@ type ContentsResultComponent<T extends ContentsOptions> = Default<(T["text"] ext
  * @property {number} [score] - Similarity score between the query/url and the result.
  * @property {string} id - The temporary ID for the document.
  */
-type SearchResult<T extends ContentsOptions = {}> = {
+type SearchResult<T extends ContentsOptions> = {
     title: string | null;
     url: string;
     publishedDate?: string;
     author?: string;
     score?: number;
     id: string;
+    image?: string;
 } & ContentsResultComponent<T>;
 /**
  * Represents a search response object.
@@ -163,7 +188,7 @@ type SearchResult<T extends ContentsOptions = {}> = {
  * @property {string} [autoDate] - The autoprompt date, if applicable.
  * @property {string} requestId - The request ID for the search.
  */
-type SearchResponse<T extends ContentsOptions = {}> = {
+type SearchResponse<T extends ContentsOptions> = {
     results: SearchResult<T>[];
     autopromptString?: string;
     autoDate?: string;
@@ -175,6 +200,7 @@ type SearchResponse<T extends ContentsOptions = {}> = {
 declare class Exa {
     private baseURL;
     private headers;
+    private extractContentsOptions;
     /**
      * Constructs the Exa API client.
      * @param {string} apiKey - The API key for authentication.
@@ -195,7 +221,7 @@ declare class Exa {
      * @param {SearchOptions} [options] - Additional search options.
      * @returns {Promise<SearchResponse>} A list of relevant search results.
      */
-    search(query: string, options?: RegularSearchOptions): Promise<SearchResponse>;
+    search(query: string, options?: RegularSearchOptions): Promise<SearchResponse<{}>>;
     /**
      * Performs a search with a Exa prompt-engineered query and returns the contents of the documents.
      * @param {string} query - The query string.
@@ -209,13 +235,8 @@ declare class Exa {
      * @param {FindSimilarOptions} [options] - Additional options for finding similar links.
      * @returns {Promise<SearchResponse>} A list of similar search results.
      */
-    findSimilar(url: string, options?: FindSimilarOptions): Promise<SearchResponse>;
-    /**
-     * 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} [options] - Additional options for finding similar links.
-     * @returns {Promise<SearchResponse>} A list of similar search results.
-     */
+    findSimilar(url: string, options?: FindSimilarOptions): Promise<SearchResponse<{}>>;
+    /** 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} [options] - Additional options for finding similar links. @returns {Promise<SearchResponse>} A list of similar search results. */
     findSimilarAndContents<T extends ContentsOptions>(url: string, options?: FindSimilarOptions & T): Promise<SearchResponse<T>>;
     /**
      * Retrieves contents of documents based on a list of document IDs.
@@ -223,7 +244,7 @@ declare class Exa {
      * @param {ContentsOptions} [options] - Additional options for retrieving document contents.
      * @returns {Promise<GetContentsResponse>} A list of document contents.
      */
-    getContents<T extends ContentsOptions>(ids: string | string[] | SearchResult[], options?: T): Promise<SearchResponse<T>>;
+    getContents<T extends ContentsOptions>(ids: string | string[] | SearchResult<T>[], options?: T): Promise<SearchResponse<T>>;
 }
 
-export { BaseSearchOptions, ContentsOptions, ContentsResultComponent, Default, FindSimilarOptions, HighlightsContentsOptions, HighlightsResponse, LivecrawlOptions, RegularSearchOptions, SearchResponse, SearchResult, SummaryContentsOptions, SummaryResponse, TextContentsOptions, TextResponse, Exa as default };
+export { BaseSearchOptions, ContentsOptions, ContentsResultComponent, Default, ExtrasOptions, ExtrasResponse, FindSimilarOptions, HighlightsContentsOptions, HighlightsResponse, LivecrawlOptions, RegularSearchOptions, SearchResponse, SearchResult, SubpagesResponse, SummaryContentsOptions, SummaryResponse, TextContentsOptions, TextResponse, Exa as default };

package/dist/index.js

@@ -35,6 +35,30 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 var import_cross_fetch = __toESM(require("cross-fetch"));
 var Exa = class {
+  extractContentsOptions(options) {
+    const { text, highlights, summary, subpages, subpageTarget, extras, livecrawl, livecrawlTimeout, ...rest } = options;
+    const contentsOptions = {};
+    if (text !== void 0)
+      contentsOptions.text = text;
+    if (highlights !== void 0)
+      contentsOptions.highlights = highlights;
+    if (summary !== void 0)
+      contentsOptions.summary = summary;
+    if (subpages !== void 0)
+      contentsOptions.subpages = subpages;
+    if (subpageTarget !== void 0)
+      contentsOptions.subpageTarget = subpageTarget;
+    if (extras !== void 0)
+      contentsOptions.extras = extras;
+    if (livecrawl !== void 0)
+      contentsOptions.livecrawl = livecrawl;
+    if (livecrawlTimeout !== void 0)
+      contentsOptions.livecrawlTimeout = livecrawlTimeout;
+    return {
+      contentsOptions,
+      restOptions: rest
+    };
+  }
   /**
    * Constructs the Exa API client.
    * @param {string} apiKey - The API key for authentication.
@@ -53,7 +77,7 @@ var Exa = class {
     this.headers = new import_cross_fetch.Headers({
       "x-api-key": apiKey,
       "Content-Type": "application/json",
-      "User-Agent": "exa-node 1.1.0"
+      "User-Agent": "exa-node 1.3.0"
     });
   }
   /**
@@ -93,19 +117,11 @@ var Exa = class {
    * @returns {Promise<SearchResponse>} A list of relevant search results.
    */
   async searchAndContents(query, options) {
-    const { text, highlights, summary, ...rest } = options || {};
+    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
     return await this.request("/search", "POST", {
       query,
-      contents: !text && !highlights && !summary ? {
-        text: true,
-        ...options
-      } : {
-        ...text ? { text } : {},
-        ...highlights ? { highlights } : {},
-        ...summary ? { summary } : {},
-        ...options
-      },
-      ...rest
+      contents: contentsOptions,
+      ...restOptions
     });
   }
   /**
@@ -117,30 +133,13 @@ var Exa = class {
   async findSimilar(url, options) {
     return await this.request("/findSimilar", "POST", { url, ...options });
   }
-  /**
-   * 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} [options] - Additional options for finding similar links.
-   * @returns {Promise<SearchResponse>} A list of similar search results.
-   */
+  /** 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} [options] - Additional options for finding similar links. @returns {Promise<SearchResponse>} A list of similar search results. */
   async findSimilarAndContents(url, options) {
-    const { text, highlights, summary, ...rest } = options || {};
+    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
     return await this.request("/findSimilar", "POST", {
       url,
-      contents: !text && !highlights && !summary ? {
-        text: true,
-        livecrawl: options?.livecrawl,
-        livecrawlTimeout: options?.livecrawlTimeout,
-        ...options
-      } : {
-        livecrawl: options?.livecrawl,
-        livecrawlTimeout: options?.livecrawlTimeout,
-        ...text ? { text } : {},
-        ...highlights ? { highlights } : {},
-        ...summary ? { summary } : {},
-        ...options
-      },
-      ...rest
+      contents: contentsOptions,
+      ...restOptions
     });
   }
   /**

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fetch, { Headers } from \"cross-fetch\";\n\nconst isBeta = false;\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} SearchOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude in the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [useAutoprompt] - If true, converts query to a Metaphor query.\n * @property {string} [type] - Type of search, 'keyword' or 'neural'.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type BaseSearchOptions = {\n  numResults?: number;\n  includeDomains?: string[];\n  excludeDomains?: string[];\n  startCrawlDate?: string;\n  endCrawlDate?: string;\n  startPublishedDate?: string;\n  endPublishedDate?: string;\n  category?: string;\n  includeText?: string[];\n  excludeText?: string[];\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} RegularSearchOptions\n */\nexport type RegularSearchOptions = BaseSearchOptions & {\n  useAutoprompt?: boolean;\n  type?: string;\n};\n\n/**\n * Options for finding similar links.\n * @typedef {Object} FindSimilarOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude from the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [excludeSourceDomain] - If true, excludes links from the base domain of the input.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type FindSimilarOptions = BaseSearchOptions & {\n  excludeSourceDomain?: boolean;\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} ContentsOptions\n * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.\n * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights.\n * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.\n * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is \"never\" for neural/auto search, \"fallback\" for keyword search.\n * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.\n * @property {boolean} [filterEmptyResults] - If true, filters out results with no contents. Default is true.\n */\nexport type ContentsOptions = {\n  text?: TextContentsOptions | true;\n  highlights?: HighlightsContentsOptions | true;\n  summary?: SummaryContentsOptions | true;\n  livecrawl?: LivecrawlOptions;\n  livecrawlTimeout?: number;\n  filterEmptyResults?: boolean;\n} & (typeof isBeta extends true ? {} : {}); // FOR BETA OPTIONS\n\n/**\n * Options for livecrawling contents\n * @typedef {string} LivecrawlOptions\n */\nexport type LivecrawlOptions = \"never\" | \"fallback\" | \"always\";\n\n/**\n * Options for retrieving text from page.\n * @typedef {Object} TextContentsOptions\n * @property {number} [maxCharacters] - The maximum number of characters to return.\n * @property {boolean} [includeHtmlTags] - If true, includes HTML tags in the returned text. Default: false\n */\nexport type TextContentsOptions = {\n  maxCharacters?: number;\n  includeHtmlTags?: boolean;\n};\n\n/**\n * Options for retrieving highlights from page.\n * @typedef {Object} HighlightsContentsOptions\n * @property {string} [query] - The query string to use for highlights search.\n * @property {number} [numSentences] - The number of sentences to return for each highlight.\n * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.\n */\nexport type HighlightsContentsOptions = {\n  query?: string;\n  numSentences?: number;\n  highlightsPerUrl?: number;\n};\n\n/**\n * Options for retrieving summary from page.\n * @typedef {Object} SummaryContentsOptions\n * @property {string} [query] - The query string to use for summary generation.\n */\nexport type SummaryContentsOptions = {\n  query?: string;\n};\n\n/**\n * @typedef {Object} TextResponse\n * @property {string} text - Text from page\n */\nexport type TextResponse = { text: string };\n\n/**\n * @typedef {Object} HighlightsResponse\n * @property {string[]} highlights - The highlights as an array of strings.\n * @property {number[]} highlightScores - The corresponding scores as an array of floats, 0 to 1\n */\nexport type HighlightsResponse = {\n  highlights: string[];\n  highlightScores: number[];\n};\n\n/**\n * @typedef {Object} SummaryResponse\n * @property {string} summary - The generated summary of the page content.\n */\nexport type SummaryResponse = { summary: string };\n\nexport type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;\n\n/**\n * @typedef {Object} ContentsResultComponent\n * Depending on 'ContentsOptions', this yields a combination of 'TextResponse', 'HighlightsResponse', 'SummaryResponse', or an empty object.\n *\n * @template T - A type extending from 'ContentsOptions'.\n */\nexport type ContentsResultComponent<T extends ContentsOptions> = Default<\n  (T[\"text\"] extends object | true ? TextResponse : {}) &\n    (T[\"highlights\"] extends object | true ? HighlightsResponse : {}) &\n    (T[\"summary\"] extends object | true ? SummaryResponse : {}),\n  TextResponse\n>;\n\n/**\n * Represents a search result object.\n * @typedef {Object} Result\n * @property {string} title - The title of the search result.\n * @property {string} url - The URL of the search result.\n * @property {string} [publishedDate] - The estimated creation date of the content.\n * @property {string} [author] - The author of the content, if available.\n * @property {number} [score] - Similarity score between the query/url and the result.\n * @property {string} id - The temporary ID for the document.\n */\nexport type SearchResult<T extends ContentsOptions = {}> = {\n  title: string | null;\n  url: string;\n  publishedDate?: string;\n  author?: string;\n  score?: number;\n  id: string;\n} & ContentsResultComponent<T>;\n\n/**\n * Represents a search response object.\n * @typedef {Object} SearchResponse\n * @property {Result[]} results - The list of search results.\n * @property {string} [autopromptString] - The autoprompt string, if applicable.\n * @property {string} [autoDate] - The autoprompt date, if applicable.\n * @property {string} requestId - The request ID for the search.\n */\nexport type SearchResponse<T extends ContentsOptions = {}> = {\n  results: SearchResult<T>[];\n  autopromptString?: string;\n  autoDate?: string;\n  requestId: string;\n};\n\n/**\n * The Exa class encapsulates the API's endpoints.\n */\nclass Exa {\n  private baseURL: string;\n  private headers: Headers;\n\n  /**\n   * Constructs the Exa API client.\n   * @param {string} apiKey - The API key for authentication.\n   * @param {string} [baseURL] - The base URL of the Exa API.\n   */\n  constructor(apiKey?: string, baseURL: string = \"https://api.exa.ai\") {\n    this.baseURL = baseURL;\n    if (!apiKey) {\n      apiKey = process.env.EXASEARCH_API_KEY;\n      if (!apiKey) {\n        throw new Error(\n          \"API key must be provided as an argument or as an environment variable (EXASEARCH_API_KEY)\"\n        );\n      }\n    }\n    this.headers = new Headers({\n      \"x-api-key\": apiKey,\n      \"Content-Type\": \"application/json\",\n      \"User-Agent\": \"exa-node 1.1.0\",\n    });\n  }\n\n  /**\n   * Makes a request to the Exa API.\n   * @param {string} endpoint - The API endpoint to call.\n   * @param {string} method - The HTTP method to use.\n   * @param {any} [body] - The request body for POST requests.\n   * @returns {Promise<any>} The response from the API.\n   */\n  private async request(\n    endpoint: string,\n    method: string,\n    body?: any\n  ): Promise<any> {\n    const response = await fetch(this.baseURL + endpoint, {\n      method,\n      headers: this.headers,\n      body: body ? JSON.stringify(body) : undefined,\n    });\n\n    if (!response.ok) {\n      const message = (await response.json()).error;\n      throw new Error(\n        `Request failed with status ${response.status}. ${message}`\n      );\n    }\n\n    return await response.json();\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async search(\n    query: string,\n    options?: RegularSearchOptions\n  ): Promise<SearchResponse> {\n    return await this.request(\"/search\", \"POST\", { query, ...options });\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query and returns the contents of the documents.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async searchAndContents<T extends ContentsOptions>(\n    query: string,\n    options?: RegularSearchOptions & T\n  ): Promise<SearchResponse<T>> {\n    const { text, highlights, summary, ...rest } = options || {};\n    return await this.request(\"/search\", \"POST\", {\n      query,\n      contents:\n        !text && !highlights && !summary\n          ? {\n              text: true,\n              ...options,\n            }\n          : {\n              ...(text ? { text } : {}),\n              ...(highlights ? { highlights } : {}),\n              ...(summary ? { summary } : {}),\n              ...options,\n            },\n      ...rest,\n    });\n  }\n\n  /**\n   * Finds similar links to the provided URL.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilar(\n    url: string,\n    options?: FindSimilarOptions\n  ): Promise<SearchResponse> {\n    return await this.request(\"/findSimilar\", \"POST\", { url, ...options });\n  }\n\n  /**\n   * Finds similar links to the provided URL and returns the contents of the documents.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilarAndContents<T extends ContentsOptions>(\n    url: string,\n    options?: FindSimilarOptions & T\n  ): Promise<SearchResponse<T>> {\n    const { text, highlights, summary, ...rest } = options || {};\n    return await this.request(\"/findSimilar\", \"POST\", {\n      url,\n      contents:\n        !text && !highlights && !summary\n          ? {\n              text: true,\n              livecrawl: options?.livecrawl,\n              livecrawlTimeout: options?.livecrawlTimeout,\n              ...options,\n            }\n          : {\n              livecrawl: options?.livecrawl,\n              livecrawlTimeout: options?.livecrawlTimeout,\n              ...(text ? { text } : {}),\n              ...(highlights ? { highlights } : {}),\n              ...(summary ? { summary } : {}),\n              ...options,\n            },\n      ...rest,\n    });\n  }\n\n  /**\n   * Retrieves contents of documents based on a list of document IDs.\n   * @param {string | string[] | SearchResult[]} ids - An array of document IDs.\n   * @param {ContentsOptions} [options] - Additional options for retrieving document contents.\n   * @returns {Promise<GetContentsResponse>} A list of document contents.\n   */\n  async getContents<T extends ContentsOptions>(\n    ids: string | string[] | SearchResult[],\n    options?: T\n  ): Promise<SearchResponse<T>> {\n    if (ids.length === 0) {\n      throw new Error(\"Must provide at least one ID\");\n    }\n    let requestIds: string[];\n    if (typeof ids === \"string\") {\n      requestIds = [ids];\n    } else if (typeof ids[0] === \"string\") {\n      requestIds = ids as string[];\n    } else {\n      requestIds = (ids as SearchResult[]).map((result) => result.id);\n    }\n    return await this.request(`/contents`, \"POST\", {\n      ids: requestIds,\n      ...options,\n    });\n  }\n}\n\nexport default Exa;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAA+B;AAiM/B,IAAM,MAAN,MAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,QAAiB,UAAkB,sBAAsB;AACnE,SAAK,UAAU;AACf,QAAI,CAAC,QAAQ;AACX,eAAS,QAAQ,IAAI;AACrB,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,SAAK,UAAU,IAAI,2BAAQ;AAAA,MACzB,aAAa;AAAA,MACb,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAc,QACZ,UACA,QACA,MACc;AACd,UAAM,WAAW,UAAM,mBAAAA,SAAM,KAAK,UAAU,UAAU;AAAA,MACpD;AAAA,MACA,SAAS,KAAK;AAAA,MACd,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,WAAW,MAAM,SAAS,KAAK,GAAG;AACxC,YAAM,IAAI;AAAA,QACR,8BAA8B,SAAS,WAAW;AAAA,MACpD;AAAA,IACF;AAEA,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,OACJ,OACA,SACyB;AACzB,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBACJ,OACA,SAC4B;AAC5B,UAAM,EAAE,MAAM,YAAY,SAAS,GAAG,KAAK,IAAI,WAAW,CAAC;AAC3D,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ;AAAA,MAC3C;AAAA,MACA,UACE,CAAC,QAAQ,CAAC,cAAc,CAAC,UACrB;AAAA,QACE,MAAM;AAAA,QACN,GAAG;AAAA,MACL,IACA;AAAA,QACE,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,QACvB,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;AAAA,QACnC,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,QAC7B,GAAG;AAAA,MACL;AAAA,MACN,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SACyB;AACzB,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,uBACJ,KACA,SAC4B;AAC5B,UAAM,EAAE,MAAM,YAAY,SAAS,GAAG,KAAK,IAAI,WAAW,CAAC;AAC3D,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ;AAAA,MAChD;AAAA,MACA,UACE,CAAC,QAAQ,CAAC,cAAc,CAAC,UACrB;AAAA,QACE,MAAM;AAAA,QACN,WAAW,SAAS;AAAA,QACpB,kBAAkB,SAAS;AAAA,QAC3B,GAAG;AAAA,MACL,IACA;AAAA,QACE,WAAW,SAAS;AAAA,QACpB,kBAAkB,SAAS;AAAA,QAC3B,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,QACvB,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;AAAA,QACnC,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,QAC7B,GAAG;AAAA,MACL;AAAA,MACN,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC4B;AAC5B,QAAI,IAAI,WAAW,GAAG;AACpB,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AACA,QAAI;AACJ,QAAI,OAAO,QAAQ,UAAU;AAC3B,mBAAa,CAAC,GAAG;AAAA,IACnB,WAAW,OAAO,IAAI,CAAC,MAAM,UAAU;AACrC,mBAAa;AAAA,IACf,OAAO;AACL,mBAAc,IAAuB,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAChE;AACA,WAAO,MAAM,KAAK,QAAQ,aAAa,QAAQ;AAAA,MAC7C,KAAK;AAAA,MACL,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;AAEA,IAAO,cAAQ;","names":["fetch"]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fetch, { Headers } from \"cross-fetch\";\n\nconst isBeta = false;\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} SearchOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude in the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [useAutoprompt] - If true, converts query to a Metaphor query.\n * @property {string} [type] - Type of search, 'keyword' or 'neural'.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type BaseSearchOptions = {\n  numResults?: number;\n  includeDomains?: string[];\n  excludeDomains?: string[];\n  startCrawlDate?: string;\n  endCrawlDate?: string;\n  startPublishedDate?: string;\n  endPublishedDate?: string;\n  category?: string;\n  includeText?: string[];\n  excludeText?: string[];\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} RegularSearchOptions\n */\nexport type RegularSearchOptions = BaseSearchOptions & {\n  useAutoprompt?: boolean;\n  type?: string;\n};\n\n/**\n * Options for finding similar links.\n * @typedef {Object} FindSimilarOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude from the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [excludeSourceDomain] - If true, excludes links from the base domain of the input.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type FindSimilarOptions = BaseSearchOptions & {\n  excludeSourceDomain?: boolean;\n};\n\nexport type ExtrasOptions = {links: number}\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} ContentsOptions\n * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.\n * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights.\n * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.\n * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is \"never\" for neural/auto search, \"fallback\" for keyword search.\n * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.\n * @property {boolean} [filterEmptyResults] - If true, filters out results with no contents. Default is true.\n * @property {number} [subpages] - The number of subpages to return for each result, where each subpage is derived from an internal link for the result\n * @property {ExtrasOptions} [extras] - Miscelleneous data for derived from resutls\n */\n\nexport type ContentsOptions = {\n  text?: TextContentsOptions | true;\n  highlights?: HighlightsContentsOptions | true;\n  summary?: SummaryContentsOptions | true;\n  livecrawl?: LivecrawlOptions;\n  livecrawlTimeout?: number;\n  filterEmptyResults?: boolean;\n  subpages?: number\n  subpageTarget?: string | string[]\n  extras?: ExtrasOptions\n} & (typeof isBeta extends true ? {} : {}); // FOR BETA OPTIONS\n\n/**\n * Options for livecrawling contents\n * @typedef {string} LivecrawlOptions\n */\nexport type LivecrawlOptions = \"never\" | \"fallback\" | \"always\";\n\n/**\n * Options for retrieving text from page.\n * @typedef {Object} TextContentsOptions\n * @property {number} [maxCharacters] - The maximum number of characters to return.\n * @property {boolean} [includeHtmlTags] - If true, includes HTML tags in the returned text. Default: false\n */\nexport type TextContentsOptions = {\n  maxCharacters?: number;\n  includeHtmlTags?: boolean;\n};\n\n/**\n * Options for retrieving highlights from page.\n * @typedef {Object} HighlightsContentsOptions\n * @property {string} [query] - The query string to use for highlights search.\n * @property {number} [numSentences] - The number of sentences to return for each highlight.\n * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.\n */\nexport type HighlightsContentsOptions = {\n  query?: string;\n  numSentences?: number;\n  highlightsPerUrl?: number;\n};\n\n/**\n * Options for retrieving summary from page.\n * @typedef {Object} SummaryContentsOptions\n * @property {string} [query] - The query string to use for summary generation.\n */\nexport type SummaryContentsOptions = {\n  query?: string;\n};\n\n/**\n * @typedef {Object} TextResponse\n * @property {string} text - Text from page\n */\nexport type TextResponse = { text: string };\n\n/**\n * @typedef {Object} HighlightsResponse\n * @property {string[]} highlights - The highlights as an array of strings.\n * @property {number[]} highlightScores - The corresponding scores as an array of floats, 0 to 1\n */\nexport type HighlightsResponse = {\n  highlights: string[];\n  highlightScores: number[];\n};\n\n/**\n * @typedef {Object} SummaryResponse\n * @property {string} summary - The generated summary of the page content.\n */\nexport type SummaryResponse = { summary: string };\n\n/**\n * @typedef {Object} ExtrasResponse\n * @property {string[]} links - The links on the page of a result\n */\nexport type ExtrasResponse = { extras: { links: string[] } };\n\n/**\n * @typedef {Object} SubpagesResponse\n * @property {ContentsResultComponent<T extends ContentsOptions>} subpages - The links on the page of a result\n */\nexport type SubpagesResponse<T extends ContentsOptions> = {subpages: ContentsResultComponent<T>[]}\n\n\n\nexport type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;\n\n/**\n * @typedef {Object} ContentsResultComponent\n * Depending on 'ContentsOptions', this yields a combination of 'TextResponse', 'HighlightsResponse', 'SummaryResponse', or an empty object.\n *\n * @template T - A type extending from 'ContentsOptions'.\n */\nexport type ContentsResultComponent<T extends ContentsOptions> = Default< \n  (T[\"text\"] extends object | true ? TextResponse : {}) &\n  (T[\"highlights\"] extends object | true ? HighlightsResponse : {}) &\n  (T[\"summary\"] extends object | true ? SummaryResponse : {}) &\n  (T[\"subpages\"] extends number ? SubpagesResponse<T> : {}) &\n  (T[\"extras\"] extends object ? ExtrasResponse : {} ),\n  TextResponse\n>;\n\n/**\n * Represents a search result object.\n * @typedef {Object} SearchResult\n * @property {string} title - The title of the search result.\n * @property {string} url - The URL of the search result.\n * @property {string} [publishedDate] - The estimated creation date of the content.\n * @property {string} [author] - The author of the content, if available.\n * @property {number} [score] - Similarity score between the query/url and the result.\n * @property {string} id - The temporary ID for the document.\n */\nexport type SearchResult<T extends ContentsOptions> = {\n  title: string | null;\n  url: string;\n  publishedDate?: string;\n  author?: string;\n  score?: number;\n  id: string;\n  image?: string;\n} & ContentsResultComponent<T>;\n\n/**\n * Represents a search response object.\n * @typedef {Object} SearchResponse\n * @property {Result[]} results - The list of search results.\n * @property {string} [autopromptString] - The autoprompt string, if applicable.\n * @property {string} [autoDate] - The autoprompt date, if applicable.\n * @property {string} requestId - The request ID for the search.\n */\nexport type SearchResponse<T extends ContentsOptions> = {\n  results: SearchResult<T>[];\n  autopromptString?: string;\n  autoDate?: string;\n  requestId: string;\n};\n\n/**\n * The Exa class encapsulates the API's endpoints.\n */\nclass Exa {\n  private baseURL: string;\n  private headers: Headers;\n\n  private extractContentsOptions<T extends ContentsOptions>(options: T): {\n    contentsOptions: ContentsOptions;\n    restOptions: Omit<T, keyof ContentsOptions>;\n  } {\n\n    const { text, highlights, summary, subpages, subpageTarget, extras, livecrawl, livecrawlTimeout, ...rest } = options;\n\n    const contentsOptions: ContentsOptions = {};\n    if (text !== undefined) contentsOptions.text = text;\n    if (highlights !== undefined) contentsOptions.highlights = highlights;\n    if (summary !== undefined) contentsOptions.summary = summary;\n    if (subpages !== undefined) contentsOptions.subpages = subpages;\n    if (subpageTarget !== undefined) contentsOptions.subpageTarget = subpageTarget;\n    if (extras !== undefined) contentsOptions.extras = extras;\n    if (livecrawl !== undefined) contentsOptions.livecrawl = livecrawl;\n    if (livecrawlTimeout !== undefined) contentsOptions.livecrawlTimeout = livecrawlTimeout;\n\n    return {\n      contentsOptions: contentsOptions,\n      restOptions: rest as Omit<T, keyof ContentsOptions>\n    };\n  }\n\n  /**\n   * Constructs the Exa API client.\n   * @param {string} apiKey - The API key for authentication.\n   * @param {string} [baseURL] - The base URL of the Exa API.\n   */\n  constructor(apiKey?: string, baseURL: string = \"https://api.exa.ai\") {\n    this.baseURL = baseURL;\n    if (!apiKey) {\n      apiKey = process.env.EXASEARCH_API_KEY;\n      if (!apiKey) {\n        throw new Error(\n          \"API key must be provided as an argument or as an environment variable (EXASEARCH_API_KEY)\",\n        );\n      }\n    }\n    this.headers = new Headers({\n      \"x-api-key\": apiKey,\n      \"Content-Type\": \"application/json\",\n      \"User-Agent\": \"exa-node 1.3.0\",\n    });\n  }\n\n  /**\n   * Makes a request to the Exa API.\n   * @param {string} endpoint - The API endpoint to call.\n   * @param {string} method - The HTTP method to use.\n   * @param {any} [body] - The request body for POST requests.\n   * @returns {Promise<any>} The response from the API.\n   */\n  private async request(\n    endpoint: string,\n    method: string,\n    body?: any,\n  ): Promise<any> {\n    const response = await fetch(this.baseURL + endpoint, {\n      method,\n      headers: this.headers,\n      body: body ? JSON.stringify(body) : undefined,\n    });\n\n    if (!response.ok) {\n      const message = (await response.json()).error;\n      throw new Error(\n        `Request failed with status ${response.status}. ${message}`,\n      );\n    }\n\n    return await response.json();\n  }\n\n\n  /**\n   * Performs a search with a Exa prompt-engineered query.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async search(\n    query: string,\n    options?: RegularSearchOptions,\n  ): Promise<SearchResponse<{}>> {\n    return await this.request(\"/search\", \"POST\", { query, ...options });\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query and returns the contents of the documents.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async searchAndContents<T extends ContentsOptions>(\n    query: string,\n    options?: RegularSearchOptions & T,\n  ): Promise<SearchResponse<T>> {\n    const { contentsOptions, restOptions } = options === undefined ? \n      { contentsOptions: { text: true }, restOptions: {}} :\n      this.extractContentsOptions(options);\n\n    return await this.request(\"/search\", \"POST\", {\n      query,\n      contents: contentsOptions,\n      ...restOptions,\n    });\n  }\n\n  /**\n   * Finds similar links to the provided URL.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilar(\n    url: string,\n    options?: FindSimilarOptions,\n  ): Promise<SearchResponse<{}>> {\n    return await this.request(\"/findSimilar\", \"POST\", { url, ...options });\n  }\n\n  /** 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} [options] - Additional options for finding similar links. @returns {Promise<SearchResponse>} A list of similar search results. */ \n  async findSimilarAndContents<T extends ContentsOptions>(\n    url: string,\n    options?: FindSimilarOptions & T,\n  ): Promise<SearchResponse<T>> {\n    const { contentsOptions, restOptions } = options === undefined ?\n      {contentsOptions: {text: true}, restOptions: {}} :\n      this.extractContentsOptions(options);\n     \n    return await this.request(\"/findSimilar\", \"POST\", {\n      url,\n      contents: contentsOptions,\n      ...restOptions,\n    });\n  }\n\n  /**\n   * Retrieves contents of documents based on a list of document IDs.\n   * @param {string | string[] | SearchResult[]} ids - An array of document IDs.\n   * @param {ContentsOptions} [options] - Additional options for retrieving document contents.\n   * @returns {Promise<GetContentsResponse>} A list of document contents.\n   */\n  async getContents<T extends ContentsOptions>(\n    ids: string | string[] | SearchResult<T>[],\n    options?: T,\n  ): Promise<SearchResponse<T>> {\n    if (ids.length === 0) {\n      throw new Error(\"Must provide at least one ID\");\n    }\n    let requestIds: string[];\n    if (typeof ids === \"string\") {\n      requestIds = [ids];\n    } else if (typeof ids[0] === \"string\") {\n      requestIds = ids as string[];\n    } else {\n      requestIds = (ids as SearchResult<T>[]).map((result) => result.id);\n    }\n    return await this.request(`/contents`, \"POST\", {\n      ids: requestIds,\n      ...options,\n    });\n  }\n}\n\nexport default Exa;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAA+B;AA0N/B,IAAM,MAAN,MAAU;AAAA,EAIA,uBAAkD,SAGxD;AAEA,UAAM,EAAE,MAAM,YAAY,SAAS,UAAU,eAAe,QAAQ,WAAW,kBAAkB,GAAG,KAAK,IAAI;AAE7G,UAAM,kBAAmC,CAAC;AAC1C,QAAI,SAAS;AAAW,sBAAgB,OAAO;AAC/C,QAAI,eAAe;AAAW,sBAAgB,aAAa;AAC3D,QAAI,YAAY;AAAW,sBAAgB,UAAU;AACrD,QAAI,aAAa;AAAW,sBAAgB,WAAW;AACvD,QAAI,kBAAkB;AAAW,sBAAgB,gBAAgB;AACjE,QAAI,WAAW;AAAW,sBAAgB,SAAS;AACnD,QAAI,cAAc;AAAW,sBAAgB,YAAY;AACzD,QAAI,qBAAqB;AAAW,sBAAgB,mBAAmB;AAEvE,WAAO;AAAA,MACL;AAAA,MACA,aAAa;AAAA,IACf;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAY,QAAiB,UAAkB,sBAAsB;AACnE,SAAK,UAAU;AACf,QAAI,CAAC,QAAQ;AACX,eAAS,QAAQ,IAAI;AACrB,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,SAAK,UAAU,IAAI,2BAAQ;AAAA,MACzB,aAAa;AAAA,MACb,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAc,QACZ,UACA,QACA,MACc;AACd,UAAM,WAAW,UAAM,mBAAAA,SAAM,KAAK,UAAU,UAAU;AAAA,MACpD;AAAA,MACA,SAAS,KAAK;AAAA,MACd,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,WAAW,MAAM,SAAS,KAAK,GAAG;AACxC,YAAM,IAAI;AAAA,QACR,8BAA8B,SAAS,WAAW;AAAA,MACpD;AAAA,IACF;AAEA,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OACJ,OACA,SAC6B;AAC7B,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBACJ,OACA,SAC4B;AAC5B,UAAM,EAAE,iBAAiB,YAAY,IAAI,YAAY,SACnD,EAAE,iBAAiB,EAAE,MAAM,KAAK,GAAG,aAAa,CAAC,EAAC,IAClD,KAAK,uBAAuB,OAAO;AAErC,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ;AAAA,MAC3C;AAAA,MACA,UAAU;AAAA,MACV,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC6B;AAC7B,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;AAAA,EACvE;AAAA;AAAA,EAGA,MAAM,uBACJ,KACA,SAC4B;AAC5B,UAAM,EAAE,iBAAiB,YAAY,IAAI,YAAY,SACnD,EAAC,iBAAiB,EAAC,MAAM,KAAI,GAAG,aAAa,CAAC,EAAC,IAC/C,KAAK,uBAAuB,OAAO;AAErC,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ;AAAA,MAChD;AAAA,MACA,UAAU;AAAA,MACV,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC4B;AAC5B,QAAI,IAAI,WAAW,GAAG;AACpB,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AACA,QAAI;AACJ,QAAI,OAAO,QAAQ,UAAU;AAC3B,mBAAa,CAAC,GAAG;AAAA,IACnB,WAAW,OAAO,IAAI,CAAC,MAAM,UAAU;AACrC,mBAAa;AAAA,IACf,OAAO;AACL,mBAAc,IAA0B,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACnE;AACA,WAAO,MAAM,KAAK,QAAQ,aAAa,QAAQ;AAAA,MAC7C,KAAK;AAAA,MACL,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;AAEA,IAAO,cAAQ;","names":["fetch"]}

package/dist/index.mjs

@@ -1,6 +1,30 @@
 // src/index.ts
 import fetch, { Headers } from "cross-fetch";
 var Exa = class {
+  extractContentsOptions(options) {
+    const { text, highlights, summary, subpages, subpageTarget, extras, livecrawl, livecrawlTimeout, ...rest } = options;
+    const contentsOptions = {};
+    if (text !== void 0)
+      contentsOptions.text = text;
+    if (highlights !== void 0)
+      contentsOptions.highlights = highlights;
+    if (summary !== void 0)
+      contentsOptions.summary = summary;
+    if (subpages !== void 0)
+      contentsOptions.subpages = subpages;
+    if (subpageTarget !== void 0)
+      contentsOptions.subpageTarget = subpageTarget;
+    if (extras !== void 0)
+      contentsOptions.extras = extras;
+    if (livecrawl !== void 0)
+      contentsOptions.livecrawl = livecrawl;
+    if (livecrawlTimeout !== void 0)
+      contentsOptions.livecrawlTimeout = livecrawlTimeout;
+    return {
+      contentsOptions,
+      restOptions: rest
+    };
+  }
   /**
    * Constructs the Exa API client.
    * @param {string} apiKey - The API key for authentication.
@@ -19,7 +43,7 @@ var Exa = class {
     this.headers = new Headers({
       "x-api-key": apiKey,
       "Content-Type": "application/json",
-      "User-Agent": "exa-node 1.1.0"
+      "User-Agent": "exa-node 1.3.0"
     });
   }
   /**
@@ -59,19 +83,11 @@ var Exa = class {
    * @returns {Promise<SearchResponse>} A list of relevant search results.
    */
   async searchAndContents(query, options) {
-    const { text, highlights, summary, ...rest } = options || {};
+    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
     return await this.request("/search", "POST", {
       query,
-      contents: !text && !highlights && !summary ? {
-        text: true,
-        ...options
-      } : {
-        ...text ? { text } : {},
-        ...highlights ? { highlights } : {},
-        ...summary ? { summary } : {},
-        ...options
-      },
-      ...rest
+      contents: contentsOptions,
+      ...restOptions
     });
   }
   /**
@@ -83,30 +99,13 @@ var Exa = class {
   async findSimilar(url, options) {
     return await this.request("/findSimilar", "POST", { url, ...options });
   }
-  /**
-   * 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} [options] - Additional options for finding similar links.
-   * @returns {Promise<SearchResponse>} A list of similar search results.
-   */
+  /** 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} [options] - Additional options for finding similar links. @returns {Promise<SearchResponse>} A list of similar search results. */
   async findSimilarAndContents(url, options) {
-    const { text, highlights, summary, ...rest } = options || {};
+    const { contentsOptions, restOptions } = options === void 0 ? { contentsOptions: { text: true }, restOptions: {} } : this.extractContentsOptions(options);
     return await this.request("/findSimilar", "POST", {
       url,
-      contents: !text && !highlights && !summary ? {
-        text: true,
-        livecrawl: options?.livecrawl,
-        livecrawlTimeout: options?.livecrawlTimeout,
-        ...options
-      } : {
-        livecrawl: options?.livecrawl,
-        livecrawlTimeout: options?.livecrawlTimeout,
-        ...text ? { text } : {},
-        ...highlights ? { highlights } : {},
-        ...summary ? { summary } : {},
-        ...options
-      },
-      ...rest
+      contents: contentsOptions,
+      ...restOptions
     });
   }
   /**

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fetch, { Headers } from \"cross-fetch\";\n\nconst isBeta = false;\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} SearchOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude in the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [useAutoprompt] - If true, converts query to a Metaphor query.\n * @property {string} [type] - Type of search, 'keyword' or 'neural'.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type BaseSearchOptions = {\n  numResults?: number;\n  includeDomains?: string[];\n  excludeDomains?: string[];\n  startCrawlDate?: string;\n  endCrawlDate?: string;\n  startPublishedDate?: string;\n  endPublishedDate?: string;\n  category?: string;\n  includeText?: string[];\n  excludeText?: string[];\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} RegularSearchOptions\n */\nexport type RegularSearchOptions = BaseSearchOptions & {\n  useAutoprompt?: boolean;\n  type?: string;\n};\n\n/**\n * Options for finding similar links.\n * @typedef {Object} FindSimilarOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude from the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [excludeSourceDomain] - If true, excludes links from the base domain of the input.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type FindSimilarOptions = BaseSearchOptions & {\n  excludeSourceDomain?: boolean;\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} ContentsOptions\n * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.\n * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights.\n * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.\n * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is \"never\" for neural/auto search, \"fallback\" for keyword search.\n * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.\n * @property {boolean} [filterEmptyResults] - If true, filters out results with no contents. Default is true.\n */\nexport type ContentsOptions = {\n  text?: TextContentsOptions | true;\n  highlights?: HighlightsContentsOptions | true;\n  summary?: SummaryContentsOptions | true;\n  livecrawl?: LivecrawlOptions;\n  livecrawlTimeout?: number;\n  filterEmptyResults?: boolean;\n} & (typeof isBeta extends true ? {} : {}); // FOR BETA OPTIONS\n\n/**\n * Options for livecrawling contents\n * @typedef {string} LivecrawlOptions\n */\nexport type LivecrawlOptions = \"never\" | \"fallback\" | \"always\";\n\n/**\n * Options for retrieving text from page.\n * @typedef {Object} TextContentsOptions\n * @property {number} [maxCharacters] - The maximum number of characters to return.\n * @property {boolean} [includeHtmlTags] - If true, includes HTML tags in the returned text. Default: false\n */\nexport type TextContentsOptions = {\n  maxCharacters?: number;\n  includeHtmlTags?: boolean;\n};\n\n/**\n * Options for retrieving highlights from page.\n * @typedef {Object} HighlightsContentsOptions\n * @property {string} [query] - The query string to use for highlights search.\n * @property {number} [numSentences] - The number of sentences to return for each highlight.\n * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.\n */\nexport type HighlightsContentsOptions = {\n  query?: string;\n  numSentences?: number;\n  highlightsPerUrl?: number;\n};\n\n/**\n * Options for retrieving summary from page.\n * @typedef {Object} SummaryContentsOptions\n * @property {string} [query] - The query string to use for summary generation.\n */\nexport type SummaryContentsOptions = {\n  query?: string;\n};\n\n/**\n * @typedef {Object} TextResponse\n * @property {string} text - Text from page\n */\nexport type TextResponse = { text: string };\n\n/**\n * @typedef {Object} HighlightsResponse\n * @property {string[]} highlights - The highlights as an array of strings.\n * @property {number[]} highlightScores - The corresponding scores as an array of floats, 0 to 1\n */\nexport type HighlightsResponse = {\n  highlights: string[];\n  highlightScores: number[];\n};\n\n/**\n * @typedef {Object} SummaryResponse\n * @property {string} summary - The generated summary of the page content.\n */\nexport type SummaryResponse = { summary: string };\n\nexport type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;\n\n/**\n * @typedef {Object} ContentsResultComponent\n * Depending on 'ContentsOptions', this yields a combination of 'TextResponse', 'HighlightsResponse', 'SummaryResponse', or an empty object.\n *\n * @template T - A type extending from 'ContentsOptions'.\n */\nexport type ContentsResultComponent<T extends ContentsOptions> = Default<\n  (T[\"text\"] extends object | true ? TextResponse : {}) &\n    (T[\"highlights\"] extends object | true ? HighlightsResponse : {}) &\n    (T[\"summary\"] extends object | true ? SummaryResponse : {}),\n  TextResponse\n>;\n\n/**\n * Represents a search result object.\n * @typedef {Object} Result\n * @property {string} title - The title of the search result.\n * @property {string} url - The URL of the search result.\n * @property {string} [publishedDate] - The estimated creation date of the content.\n * @property {string} [author] - The author of the content, if available.\n * @property {number} [score] - Similarity score between the query/url and the result.\n * @property {string} id - The temporary ID for the document.\n */\nexport type SearchResult<T extends ContentsOptions = {}> = {\n  title: string | null;\n  url: string;\n  publishedDate?: string;\n  author?: string;\n  score?: number;\n  id: string;\n} & ContentsResultComponent<T>;\n\n/**\n * Represents a search response object.\n * @typedef {Object} SearchResponse\n * @property {Result[]} results - The list of search results.\n * @property {string} [autopromptString] - The autoprompt string, if applicable.\n * @property {string} [autoDate] - The autoprompt date, if applicable.\n * @property {string} requestId - The request ID for the search.\n */\nexport type SearchResponse<T extends ContentsOptions = {}> = {\n  results: SearchResult<T>[];\n  autopromptString?: string;\n  autoDate?: string;\n  requestId: string;\n};\n\n/**\n * The Exa class encapsulates the API's endpoints.\n */\nclass Exa {\n  private baseURL: string;\n  private headers: Headers;\n\n  /**\n   * Constructs the Exa API client.\n   * @param {string} apiKey - The API key for authentication.\n   * @param {string} [baseURL] - The base URL of the Exa API.\n   */\n  constructor(apiKey?: string, baseURL: string = \"https://api.exa.ai\") {\n    this.baseURL = baseURL;\n    if (!apiKey) {\n      apiKey = process.env.EXASEARCH_API_KEY;\n      if (!apiKey) {\n        throw new Error(\n          \"API key must be provided as an argument or as an environment variable (EXASEARCH_API_KEY)\"\n        );\n      }\n    }\n    this.headers = new Headers({\n      \"x-api-key\": apiKey,\n      \"Content-Type\": \"application/json\",\n      \"User-Agent\": \"exa-node 1.1.0\",\n    });\n  }\n\n  /**\n   * Makes a request to the Exa API.\n   * @param {string} endpoint - The API endpoint to call.\n   * @param {string} method - The HTTP method to use.\n   * @param {any} [body] - The request body for POST requests.\n   * @returns {Promise<any>} The response from the API.\n   */\n  private async request(\n    endpoint: string,\n    method: string,\n    body?: any\n  ): Promise<any> {\n    const response = await fetch(this.baseURL + endpoint, {\n      method,\n      headers: this.headers,\n      body: body ? JSON.stringify(body) : undefined,\n    });\n\n    if (!response.ok) {\n      const message = (await response.json()).error;\n      throw new Error(\n        `Request failed with status ${response.status}. ${message}`\n      );\n    }\n\n    return await response.json();\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async search(\n    query: string,\n    options?: RegularSearchOptions\n  ): Promise<SearchResponse> {\n    return await this.request(\"/search\", \"POST\", { query, ...options });\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query and returns the contents of the documents.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async searchAndContents<T extends ContentsOptions>(\n    query: string,\n    options?: RegularSearchOptions & T\n  ): Promise<SearchResponse<T>> {\n    const { text, highlights, summary, ...rest } = options || {};\n    return await this.request(\"/search\", \"POST\", {\n      query,\n      contents:\n        !text && !highlights && !summary\n          ? {\n              text: true,\n              ...options,\n            }\n          : {\n              ...(text ? { text } : {}),\n              ...(highlights ? { highlights } : {}),\n              ...(summary ? { summary } : {}),\n              ...options,\n            },\n      ...rest,\n    });\n  }\n\n  /**\n   * Finds similar links to the provided URL.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilar(\n    url: string,\n    options?: FindSimilarOptions\n  ): Promise<SearchResponse> {\n    return await this.request(\"/findSimilar\", \"POST\", { url, ...options });\n  }\n\n  /**\n   * Finds similar links to the provided URL and returns the contents of the documents.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilarAndContents<T extends ContentsOptions>(\n    url: string,\n    options?: FindSimilarOptions & T\n  ): Promise<SearchResponse<T>> {\n    const { text, highlights, summary, ...rest } = options || {};\n    return await this.request(\"/findSimilar\", \"POST\", {\n      url,\n      contents:\n        !text && !highlights && !summary\n          ? {\n              text: true,\n              livecrawl: options?.livecrawl,\n              livecrawlTimeout: options?.livecrawlTimeout,\n              ...options,\n            }\n          : {\n              livecrawl: options?.livecrawl,\n              livecrawlTimeout: options?.livecrawlTimeout,\n              ...(text ? { text } : {}),\n              ...(highlights ? { highlights } : {}),\n              ...(summary ? { summary } : {}),\n              ...options,\n            },\n      ...rest,\n    });\n  }\n\n  /**\n   * Retrieves contents of documents based on a list of document IDs.\n   * @param {string | string[] | SearchResult[]} ids - An array of document IDs.\n   * @param {ContentsOptions} [options] - Additional options for retrieving document contents.\n   * @returns {Promise<GetContentsResponse>} A list of document contents.\n   */\n  async getContents<T extends ContentsOptions>(\n    ids: string | string[] | SearchResult[],\n    options?: T\n  ): Promise<SearchResponse<T>> {\n    if (ids.length === 0) {\n      throw new Error(\"Must provide at least one ID\");\n    }\n    let requestIds: string[];\n    if (typeof ids === \"string\") {\n      requestIds = [ids];\n    } else if (typeof ids[0] === \"string\") {\n      requestIds = ids as string[];\n    } else {\n      requestIds = (ids as SearchResult[]).map((result) => result.id);\n    }\n    return await this.request(`/contents`, \"POST\", {\n      ids: requestIds,\n      ...options,\n    });\n  }\n}\n\nexport default Exa;\n"],"mappings":";AAAA,OAAO,SAAS,eAAe;AAiM/B,IAAM,MAAN,MAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,QAAiB,UAAkB,sBAAsB;AACnE,SAAK,UAAU;AACf,QAAI,CAAC,QAAQ;AACX,eAAS,QAAQ,IAAI;AACrB,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,SAAK,UAAU,IAAI,QAAQ;AAAA,MACzB,aAAa;AAAA,MACb,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAc,QACZ,UACA,QACA,MACc;AACd,UAAM,WAAW,MAAM,MAAM,KAAK,UAAU,UAAU;AAAA,MACpD;AAAA,MACA,SAAS,KAAK;AAAA,MACd,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,WAAW,MAAM,SAAS,KAAK,GAAG;AACxC,YAAM,IAAI;AAAA,QACR,8BAA8B,SAAS,WAAW;AAAA,MACpD;AAAA,IACF;AAEA,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,OACJ,OACA,SACyB;AACzB,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBACJ,OACA,SAC4B;AAC5B,UAAM,EAAE,MAAM,YAAY,SAAS,GAAG,KAAK,IAAI,WAAW,CAAC;AAC3D,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ;AAAA,MAC3C;AAAA,MACA,UACE,CAAC,QAAQ,CAAC,cAAc,CAAC,UACrB;AAAA,QACE,MAAM;AAAA,QACN,GAAG;AAAA,MACL,IACA;AAAA,QACE,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,QACvB,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;AAAA,QACnC,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,QAC7B,GAAG;AAAA,MACL;AAAA,MACN,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SACyB;AACzB,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,uBACJ,KACA,SAC4B;AAC5B,UAAM,EAAE,MAAM,YAAY,SAAS,GAAG,KAAK,IAAI,WAAW,CAAC;AAC3D,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ;AAAA,MAChD;AAAA,MACA,UACE,CAAC,QAAQ,CAAC,cAAc,CAAC,UACrB;AAAA,QACE,MAAM;AAAA,QACN,WAAW,SAAS;AAAA,QACpB,kBAAkB,SAAS;AAAA,QAC3B,GAAG;AAAA,MACL,IACA;AAAA,QACE,WAAW,SAAS;AAAA,QACpB,kBAAkB,SAAS;AAAA,QAC3B,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,QACvB,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;AAAA,QACnC,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,QAC7B,GAAG;AAAA,MACL;AAAA,MACN,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC4B;AAC5B,QAAI,IAAI,WAAW,GAAG;AACpB,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AACA,QAAI;AACJ,QAAI,OAAO,QAAQ,UAAU;AAC3B,mBAAa,CAAC,GAAG;AAAA,IACnB,WAAW,OAAO,IAAI,CAAC,MAAM,UAAU;AACrC,mBAAa;AAAA,IACf,OAAO;AACL,mBAAc,IAAuB,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAChE;AACA,WAAO,MAAM,KAAK,QAAQ,aAAa,QAAQ;AAAA,MAC7C,KAAK;AAAA,MACL,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;AAEA,IAAO,cAAQ;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fetch, { Headers } from \"cross-fetch\";\n\nconst isBeta = false;\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} SearchOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude in the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [useAutoprompt] - If true, converts query to a Metaphor query.\n * @property {string} [type] - Type of search, 'keyword' or 'neural'.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type BaseSearchOptions = {\n  numResults?: number;\n  includeDomains?: string[];\n  excludeDomains?: string[];\n  startCrawlDate?: string;\n  endCrawlDate?: string;\n  startPublishedDate?: string;\n  endPublishedDate?: string;\n  category?: string;\n  includeText?: string[];\n  excludeText?: string[];\n};\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} RegularSearchOptions\n */\nexport type RegularSearchOptions = BaseSearchOptions & {\n  useAutoprompt?: boolean;\n  type?: string;\n};\n\n/**\n * Options for finding similar links.\n * @typedef {Object} FindSimilarOptions\n * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.\n * @property {string[]} [includeDomains] - List of domains to include in the search.\n * @property {string[]} [excludeDomains] - List of domains to exclude from the search.\n * @property {string} [startCrawlDate] - Start date for results based on crawl date.\n * @property {string} [endCrawlDate] - End date for results based on crawl date.\n * @property {string} [startPublishedDate] - Start date for results based on published date.\n * @property {string} [endPublishedDate] - End date for results based on published date.\n * @property {boolean} [excludeSourceDomain] - If true, excludes links from the base domain of the input.\n * @property {string} [category] - A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.\n * @property {string[]} [includeText] - List of strings that must be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n * @property {string[]} [excludeText] - List of strings that must not be present in webpage text of results. Currently only supports 1 string of up to 5 words.\n */\nexport type FindSimilarOptions = BaseSearchOptions & {\n  excludeSourceDomain?: boolean;\n};\n\nexport type ExtrasOptions = {links: number}\n\n/**\n * Search options for performing a search query.\n * @typedef {Object} ContentsOptions\n * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.\n * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights.\n * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.\n * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is \"never\" for neural/auto search, \"fallback\" for keyword search.\n * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.\n * @property {boolean} [filterEmptyResults] - If true, filters out results with no contents. Default is true.\n * @property {number} [subpages] - The number of subpages to return for each result, where each subpage is derived from an internal link for the result\n * @property {ExtrasOptions} [extras] - Miscelleneous data for derived from resutls\n */\n\nexport type ContentsOptions = {\n  text?: TextContentsOptions | true;\n  highlights?: HighlightsContentsOptions | true;\n  summary?: SummaryContentsOptions | true;\n  livecrawl?: LivecrawlOptions;\n  livecrawlTimeout?: number;\n  filterEmptyResults?: boolean;\n  subpages?: number\n  subpageTarget?: string | string[]\n  extras?: ExtrasOptions\n} & (typeof isBeta extends true ? {} : {}); // FOR BETA OPTIONS\n\n/**\n * Options for livecrawling contents\n * @typedef {string} LivecrawlOptions\n */\nexport type LivecrawlOptions = \"never\" | \"fallback\" | \"always\";\n\n/**\n * Options for retrieving text from page.\n * @typedef {Object} TextContentsOptions\n * @property {number} [maxCharacters] - The maximum number of characters to return.\n * @property {boolean} [includeHtmlTags] - If true, includes HTML tags in the returned text. Default: false\n */\nexport type TextContentsOptions = {\n  maxCharacters?: number;\n  includeHtmlTags?: boolean;\n};\n\n/**\n * Options for retrieving highlights from page.\n * @typedef {Object} HighlightsContentsOptions\n * @property {string} [query] - The query string to use for highlights search.\n * @property {number} [numSentences] - The number of sentences to return for each highlight.\n * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.\n */\nexport type HighlightsContentsOptions = {\n  query?: string;\n  numSentences?: number;\n  highlightsPerUrl?: number;\n};\n\n/**\n * Options for retrieving summary from page.\n * @typedef {Object} SummaryContentsOptions\n * @property {string} [query] - The query string to use for summary generation.\n */\nexport type SummaryContentsOptions = {\n  query?: string;\n};\n\n/**\n * @typedef {Object} TextResponse\n * @property {string} text - Text from page\n */\nexport type TextResponse = { text: string };\n\n/**\n * @typedef {Object} HighlightsResponse\n * @property {string[]} highlights - The highlights as an array of strings.\n * @property {number[]} highlightScores - The corresponding scores as an array of floats, 0 to 1\n */\nexport type HighlightsResponse = {\n  highlights: string[];\n  highlightScores: number[];\n};\n\n/**\n * @typedef {Object} SummaryResponse\n * @property {string} summary - The generated summary of the page content.\n */\nexport type SummaryResponse = { summary: string };\n\n/**\n * @typedef {Object} ExtrasResponse\n * @property {string[]} links - The links on the page of a result\n */\nexport type ExtrasResponse = { extras: { links: string[] } };\n\n/**\n * @typedef {Object} SubpagesResponse\n * @property {ContentsResultComponent<T extends ContentsOptions>} subpages - The links on the page of a result\n */\nexport type SubpagesResponse<T extends ContentsOptions> = {subpages: ContentsResultComponent<T>[]}\n\n\n\nexport type Default<T extends {}, U> = [keyof T] extends [never] ? U : T;\n\n/**\n * @typedef {Object} ContentsResultComponent\n * Depending on 'ContentsOptions', this yields a combination of 'TextResponse', 'HighlightsResponse', 'SummaryResponse', or an empty object.\n *\n * @template T - A type extending from 'ContentsOptions'.\n */\nexport type ContentsResultComponent<T extends ContentsOptions> = Default< \n  (T[\"text\"] extends object | true ? TextResponse : {}) &\n  (T[\"highlights\"] extends object | true ? HighlightsResponse : {}) &\n  (T[\"summary\"] extends object | true ? SummaryResponse : {}) &\n  (T[\"subpages\"] extends number ? SubpagesResponse<T> : {}) &\n  (T[\"extras\"] extends object ? ExtrasResponse : {} ),\n  TextResponse\n>;\n\n/**\n * Represents a search result object.\n * @typedef {Object} SearchResult\n * @property {string} title - The title of the search result.\n * @property {string} url - The URL of the search result.\n * @property {string} [publishedDate] - The estimated creation date of the content.\n * @property {string} [author] - The author of the content, if available.\n * @property {number} [score] - Similarity score between the query/url and the result.\n * @property {string} id - The temporary ID for the document.\n */\nexport type SearchResult<T extends ContentsOptions> = {\n  title: string | null;\n  url: string;\n  publishedDate?: string;\n  author?: string;\n  score?: number;\n  id: string;\n  image?: string;\n} & ContentsResultComponent<T>;\n\n/**\n * Represents a search response object.\n * @typedef {Object} SearchResponse\n * @property {Result[]} results - The list of search results.\n * @property {string} [autopromptString] - The autoprompt string, if applicable.\n * @property {string} [autoDate] - The autoprompt date, if applicable.\n * @property {string} requestId - The request ID for the search.\n */\nexport type SearchResponse<T extends ContentsOptions> = {\n  results: SearchResult<T>[];\n  autopromptString?: string;\n  autoDate?: string;\n  requestId: string;\n};\n\n/**\n * The Exa class encapsulates the API's endpoints.\n */\nclass Exa {\n  private baseURL: string;\n  private headers: Headers;\n\n  private extractContentsOptions<T extends ContentsOptions>(options: T): {\n    contentsOptions: ContentsOptions;\n    restOptions: Omit<T, keyof ContentsOptions>;\n  } {\n\n    const { text, highlights, summary, subpages, subpageTarget, extras, livecrawl, livecrawlTimeout, ...rest } = options;\n\n    const contentsOptions: ContentsOptions = {};\n    if (text !== undefined) contentsOptions.text = text;\n    if (highlights !== undefined) contentsOptions.highlights = highlights;\n    if (summary !== undefined) contentsOptions.summary = summary;\n    if (subpages !== undefined) contentsOptions.subpages = subpages;\n    if (subpageTarget !== undefined) contentsOptions.subpageTarget = subpageTarget;\n    if (extras !== undefined) contentsOptions.extras = extras;\n    if (livecrawl !== undefined) contentsOptions.livecrawl = livecrawl;\n    if (livecrawlTimeout !== undefined) contentsOptions.livecrawlTimeout = livecrawlTimeout;\n\n    return {\n      contentsOptions: contentsOptions,\n      restOptions: rest as Omit<T, keyof ContentsOptions>\n    };\n  }\n\n  /**\n   * Constructs the Exa API client.\n   * @param {string} apiKey - The API key for authentication.\n   * @param {string} [baseURL] - The base URL of the Exa API.\n   */\n  constructor(apiKey?: string, baseURL: string = \"https://api.exa.ai\") {\n    this.baseURL = baseURL;\n    if (!apiKey) {\n      apiKey = process.env.EXASEARCH_API_KEY;\n      if (!apiKey) {\n        throw new Error(\n          \"API key must be provided as an argument or as an environment variable (EXASEARCH_API_KEY)\",\n        );\n      }\n    }\n    this.headers = new Headers({\n      \"x-api-key\": apiKey,\n      \"Content-Type\": \"application/json\",\n      \"User-Agent\": \"exa-node 1.3.0\",\n    });\n  }\n\n  /**\n   * Makes a request to the Exa API.\n   * @param {string} endpoint - The API endpoint to call.\n   * @param {string} method - The HTTP method to use.\n   * @param {any} [body] - The request body for POST requests.\n   * @returns {Promise<any>} The response from the API.\n   */\n  private async request(\n    endpoint: string,\n    method: string,\n    body?: any,\n  ): Promise<any> {\n    const response = await fetch(this.baseURL + endpoint, {\n      method,\n      headers: this.headers,\n      body: body ? JSON.stringify(body) : undefined,\n    });\n\n    if (!response.ok) {\n      const message = (await response.json()).error;\n      throw new Error(\n        `Request failed with status ${response.status}. ${message}`,\n      );\n    }\n\n    return await response.json();\n  }\n\n\n  /**\n   * Performs a search with a Exa prompt-engineered query.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async search(\n    query: string,\n    options?: RegularSearchOptions,\n  ): Promise<SearchResponse<{}>> {\n    return await this.request(\"/search\", \"POST\", { query, ...options });\n  }\n\n  /**\n   * Performs a search with a Exa prompt-engineered query and returns the contents of the documents.\n   * @param {string} query - The query string.\n   * @param {SearchOptions} [options] - Additional search options.\n   * @returns {Promise<SearchResponse>} A list of relevant search results.\n   */\n  async searchAndContents<T extends ContentsOptions>(\n    query: string,\n    options?: RegularSearchOptions & T,\n  ): Promise<SearchResponse<T>> {\n    const { contentsOptions, restOptions } = options === undefined ? \n      { contentsOptions: { text: true }, restOptions: {}} :\n      this.extractContentsOptions(options);\n\n    return await this.request(\"/search\", \"POST\", {\n      query,\n      contents: contentsOptions,\n      ...restOptions,\n    });\n  }\n\n  /**\n   * Finds similar links to the provided URL.\n   * @param {string} url - The URL for which to find similar links.\n   * @param {FindSimilarOptions} [options] - Additional options for finding similar links.\n   * @returns {Promise<SearchResponse>} A list of similar search results.\n   */\n  async findSimilar(\n    url: string,\n    options?: FindSimilarOptions,\n  ): Promise<SearchResponse<{}>> {\n    return await this.request(\"/findSimilar\", \"POST\", { url, ...options });\n  }\n\n  /** 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} [options] - Additional options for finding similar links. @returns {Promise<SearchResponse>} A list of similar search results. */ \n  async findSimilarAndContents<T extends ContentsOptions>(\n    url: string,\n    options?: FindSimilarOptions & T,\n  ): Promise<SearchResponse<T>> {\n    const { contentsOptions, restOptions } = options === undefined ?\n      {contentsOptions: {text: true}, restOptions: {}} :\n      this.extractContentsOptions(options);\n     \n    return await this.request(\"/findSimilar\", \"POST\", {\n      url,\n      contents: contentsOptions,\n      ...restOptions,\n    });\n  }\n\n  /**\n   * Retrieves contents of documents based on a list of document IDs.\n   * @param {string | string[] | SearchResult[]} ids - An array of document IDs.\n   * @param {ContentsOptions} [options] - Additional options for retrieving document contents.\n   * @returns {Promise<GetContentsResponse>} A list of document contents.\n   */\n  async getContents<T extends ContentsOptions>(\n    ids: string | string[] | SearchResult<T>[],\n    options?: T,\n  ): Promise<SearchResponse<T>> {\n    if (ids.length === 0) {\n      throw new Error(\"Must provide at least one ID\");\n    }\n    let requestIds: string[];\n    if (typeof ids === \"string\") {\n      requestIds = [ids];\n    } else if (typeof ids[0] === \"string\") {\n      requestIds = ids as string[];\n    } else {\n      requestIds = (ids as SearchResult<T>[]).map((result) => result.id);\n    }\n    return await this.request(`/contents`, \"POST\", {\n      ids: requestIds,\n      ...options,\n    });\n  }\n}\n\nexport default Exa;\n"],"mappings":";AAAA,OAAO,SAAS,eAAe;AA0N/B,IAAM,MAAN,MAAU;AAAA,EAIA,uBAAkD,SAGxD;AAEA,UAAM,EAAE,MAAM,YAAY,SAAS,UAAU,eAAe,QAAQ,WAAW,kBAAkB,GAAG,KAAK,IAAI;AAE7G,UAAM,kBAAmC,CAAC;AAC1C,QAAI,SAAS;AAAW,sBAAgB,OAAO;AAC/C,QAAI,eAAe;AAAW,sBAAgB,aAAa;AAC3D,QAAI,YAAY;AAAW,sBAAgB,UAAU;AACrD,QAAI,aAAa;AAAW,sBAAgB,WAAW;AACvD,QAAI,kBAAkB;AAAW,sBAAgB,gBAAgB;AACjE,QAAI,WAAW;AAAW,sBAAgB,SAAS;AACnD,QAAI,cAAc;AAAW,sBAAgB,YAAY;AACzD,QAAI,qBAAqB;AAAW,sBAAgB,mBAAmB;AAEvE,WAAO;AAAA,MACL;AAAA,MACA,aAAa;AAAA,IACf;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAY,QAAiB,UAAkB,sBAAsB;AACnE,SAAK,UAAU;AACf,QAAI,CAAC,QAAQ;AACX,eAAS,QAAQ,IAAI;AACrB,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,SAAK,UAAU,IAAI,QAAQ;AAAA,MACzB,aAAa;AAAA,MACb,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAc,QACZ,UACA,QACA,MACc;AACd,UAAM,WAAW,MAAM,MAAM,KAAK,UAAU,UAAU;AAAA,MACpD;AAAA,MACA,SAAS,KAAK;AAAA,MACd,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,WAAW,MAAM,SAAS,KAAK,GAAG;AACxC,YAAM,IAAI;AAAA,QACR,8BAA8B,SAAS,WAAW;AAAA,MACpD;AAAA,IACF;AAEA,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OACJ,OACA,SAC6B;AAC7B,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBACJ,OACA,SAC4B;AAC5B,UAAM,EAAE,iBAAiB,YAAY,IAAI,YAAY,SACnD,EAAE,iBAAiB,EAAE,MAAM,KAAK,GAAG,aAAa,CAAC,EAAC,IAClD,KAAK,uBAAuB,OAAO;AAErC,WAAO,MAAM,KAAK,QAAQ,WAAW,QAAQ;AAAA,MAC3C;AAAA,MACA,UAAU;AAAA,MACV,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC6B;AAC7B,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;AAAA,EACvE;AAAA;AAAA,EAGA,MAAM,uBACJ,KACA,SAC4B;AAC5B,UAAM,EAAE,iBAAiB,YAAY,IAAI,YAAY,SACnD,EAAC,iBAAiB,EAAC,MAAM,KAAI,GAAG,aAAa,CAAC,EAAC,IAC/C,KAAK,uBAAuB,OAAO;AAErC,WAAO,MAAM,KAAK,QAAQ,gBAAgB,QAAQ;AAAA,MAChD;AAAA,MACA,UAAU;AAAA,MACV,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,YACJ,KACA,SAC4B;AAC5B,QAAI,IAAI,WAAW,GAAG;AACpB,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AACA,QAAI;AACJ,QAAI,OAAO,QAAQ,UAAU;AAC3B,mBAAa,CAAC,GAAG;AAAA,IACnB,WAAW,OAAO,IAAI,CAAC,MAAM,UAAU;AACrC,mBAAa;AAAA,IACf,OAAO;AACL,mBAAc,IAA0B,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACnE;AACA,WAAO,MAAM,KAAK,QAAQ,aAAa,QAAQ;AAAA,MAC7C,KAAK;AAAA,MACL,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;AAEA,IAAO,cAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exa-js",
-  "version": "1.1.3",
+  "version": "1.3.0",
   "description": "Exa SDK for Node.js and the browser",
   "publishConfig": {
     "access": "public"