exa-js 1.0.0 → 1.0.2

package/README.md

@@ -1 +1,47 @@
-# exasearch
+# exa-js
+
+Our official Javscript SDK. Uses `cross-fetch` under the hood.
+
+https://www.npmjs.com/package/exa-js
+
+## Installation
+```
+npm install exa-js
+```
+
+## Initialization 
+```js
+import Exa from "exa-node"
+
+const exa = new Exa(process.env.EXA_API_KEY)
+```
+
+### `exa.search(query: string, options?: SearchOptions): Promise<SearchResponse>`
+Performs a search on the Exa system with the given parameters.
+
+```javascript
+const response = await exa.search('funny article about tech culture', {
+  numResults: 5,
+  includeDomains: ['nytimes.com', 'wsj.com'], 
+  startPublishedDate: '2023-06-12'
+});
+```
+
+### `exa.findSimilar(url: string, options?: FindSimilarOptions): Promise<SearchResponse>`
+Finds content similar to the specified URL.
+
+```javascript
+const response = await exa.findSimilar('https://waitbutwhy.com/2014/05/fermi-paradox.html', {
+  numResults: 10
+});
+```
+
+### `exa.getContents(ids: string[] | Result[]): Promise<GetContentsResponse>`
+Retrieves the contents of the specified documents.
+
+```javascript
+const response = await exa.getContents(['8U71IlQ5DUTdsZFherhhYA', 'X3wd0PbJmAvhu_DQjDKA7A']);
+```
+
+# Contributing
+Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

package/dist/index.d.ts

@@ -74,8 +74,8 @@ 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>;
-    searchAndContents<T extends ContentsOptions>(query: string, options: RegularSearchOptions & T): Promise<SearchResponse<T>>;
+    search(query: string, options?: RegularSearchOptions): Promise<SearchResponse>;
+    searchAndContents<T extends ContentsOptions>(query: string, options?: RegularSearchOptions & T): Promise<SearchResponse<T>>;
     /**
      * Finds similar links to the provided URL.
      * @param {string} url - The URL for which to find similar links.
@@ -83,7 +83,7 @@ declare class Exa {
      * @returns {Promise<SearchResponse>} A list of similar search results.
      */
     findSimilar(url: string, options?: FindSimilarOptions): Promise<SearchResponse>;
-    findSimilarAndContents<T extends ContentsOptions>(url: string, options: FindSimilarOptions & T): Promise<SearchResponse<T>>;
+    findSimilarAndContents<T extends ContentsOptions>(url: string, options?: FindSimilarOptions & T): Promise<SearchResponse<T>>;
     /**
      * Retrieves contents of documents based on a list of document IDs.
      * @param {string | string[] | SearchResult[]} ids - An array of document IDs.

package/dist/index.js

@@ -85,7 +85,7 @@ var Exa = class {
     return await this.request("/search", "POST", { query, ...options });
   }
   async searchAndContents(query, options) {
-    const { text, highlights, ...rest } = options;
+    const { text, highlights, ...rest } = options || {};
     return await this.request("/search", "POST", {
       query,
       contents: {
@@ -105,7 +105,7 @@ var Exa = class {
     return await this.request("/findSimilar", "POST", { url, ...options });
   }
   async findSimilarAndContents(url, options) {
-    const { text, highlights, ...rest } = options;
+    const { text, highlights, ...rest } = options || {};
     return await this.request("/findSimilar", "POST", {
       url,
       contents: {

package/dist/index.mjs

@@ -51,7 +51,7 @@ var Exa = class {
     return await this.request("/search", "POST", { query, ...options });
   }
   async searchAndContents(query, options) {
-    const { text, highlights, ...rest } = options;
+    const { text, highlights, ...rest } = options || {};
     return await this.request("/search", "POST", {
       query,
       contents: {
@@ -71,7 +71,7 @@ var Exa = class {
     return await this.request("/findSimilar", "POST", { url, ...options });
   }
   async findSimilarAndContents(url, options) {
-    const { text, highlights, ...rest } = options;
+    const { text, highlights, ...rest } = options || {};
     return await this.request("/findSimilar", "POST", {
       url,
       contents: {

package/package.json

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