langchain 0.0.203 → 0.0.204-rc.0

package/dist/tools/dataforseo_api_search.cjs

@@ -1,282 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataForSeoAPISearch = void 0;
-const env_js_1 = require("../util/env.cjs");
-const base_js_1 = require("./base.cjs");
-/**
- * @class DataForSeoAPISearch
- * @extends {Tool}
- * @description Represents a wrapper class to work with DataForSEO SERP API.
- */
-class DataForSeoAPISearch extends base_js_1.Tool {
-    static lc_name() {
-        return "DataForSeoAPISearch";
-    }
-    /**
-     * @constructor
-     * @param {DataForSeoApiConfig} config
-     * @description Sets up the class, throws an error if the API login/password isn't provided.
-     */
-    constructor(config = {}) {
-        super();
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "dataforseo-api-wrapper"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "A robust Google Search API provided by DataForSeo. This tool is handy when you need information about trending topics or current events."
-        });
-        Object.defineProperty(this, "apiLogin", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "apiPassword", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * @property defaultParams
-         * @type {Record<string, string | number | boolean>}
-         * @description These are the default parameters to be used when making an API request.
-         */
-        Object.defineProperty(this, "defaultParams", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {
-                location_name: "United States",
-                language_code: "en",
-                depth: 10,
-                se_name: "google",
-                se_type: "organic",
-            }
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        Object.defineProperty(this, "jsonResultTypes", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "jsonResultFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "topCount", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "useJsonOutput", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        const apiLogin = config.apiLogin ?? (0, env_js_1.getEnvironmentVariable)("DATAFORSEO_LOGIN");
-        const apiPassword = config.apiPassword ?? (0, env_js_1.getEnvironmentVariable)("DATAFORSEO_PASSWORD");
-        const params = config.params ?? {};
-        if (!apiLogin || !apiPassword) {
-            throw new Error("DataForSEO login or password not set. You can set it as DATAFORSEO_LOGIN and DATAFORSEO_PASSWORD in your .env file, or pass it to DataForSeoAPISearch.");
-        }
-        this.params = { ...this.defaultParams, ...params };
-        this.apiLogin = apiLogin;
-        this.apiPassword = apiPassword;
-        this.jsonResultTypes = config.jsonResultTypes;
-        this.jsonResultFields = config.jsonResultFields;
-        this.useJsonOutput = config.useJsonOutput ?? false;
-        this.topCount = config.topCount;
-    }
-    /**
-     * @method _call
-     * @param {string} keyword
-     * @returns {Promise<string>}
-     * @description Initiates a call to the API and processes the response.
-     */
-    async _call(keyword) {
-        return this.useJsonOutput
-            ? JSON.stringify(await this.results(keyword))
-            : this.processResponse(await this.getResponseJson(keyword));
-    }
-    /**
-     * @method results
-     * @param {string} keyword
-     * @returns {Promise<Array<any>>}
-     * @description Fetches the results from the API for the given keyword.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    async results(keyword) {
-        const res = await this.getResponseJson(keyword);
-        return this.filterResults(res, this.jsonResultTypes);
-    }
-    /**
-     * @method prepareRequest
-     * @param {string} keyword
-     * @returns {{url: string; headers: HeadersInit; data: BodyInit}}
-     * @description Prepares the request details for the API call.
-     */
-    prepareRequest(keyword) {
-        if (this.apiLogin === undefined || this.apiPassword === undefined) {
-            throw new Error("api_login or api_password is not provided");
-        }
-        const credentials = Buffer.from(`${this.apiLogin}:${this.apiPassword}`, "utf-8").toString("base64");
-        const headers = {
-            Authorization: `Basic ${credentials}`,
-            "Content-Type": "application/json",
-        };
-        const params = { ...this.params };
-        params.keyword ??= keyword;
-        const data = [params];
-        return {
-            url: `https://api.dataforseo.com/v3/serp/${params.se_name}/${params.se_type}/live/advanced`,
-            headers,
-            data: JSON.stringify(data),
-        };
-    }
-    /**
-     * @method getResponseJson
-     * @param {string} keyword
-     * @returns {Promise<ApiResponse>}
-     * @description Executes a POST request to the provided URL and returns a parsed JSON response.
-     */
-    async getResponseJson(keyword) {
-        const requestDetails = this.prepareRequest(keyword);
-        const response = await fetch(requestDetails.url, {
-            method: "POST",
-            headers: requestDetails.headers,
-            body: requestDetails.data,
-        });
-        if (!response.ok) {
-            throw new Error(`Got ${response.status} error from DataForSEO: ${response.statusText}`);
-        }
-        const result = await response.json();
-        return this.checkResponse(result);
-    }
-    /**
-     * @method checkResponse
-     * @param {ApiResponse} response
-     * @returns {ApiResponse}
-     * @description Checks the response status code.
-     */
-    checkResponse(response) {
-        if (response.status_code !== 20000) {
-            throw new Error(`Got error from DataForSEO SERP API: ${response.status_message}`);
-        }
-        for (const task of response.tasks) {
-            if (task.status_code !== 20000) {
-                throw new Error(`Got error from DataForSEO SERP API: ${task.status_message}`);
-            }
-        }
-        return response;
-    }
-    /* eslint-disable @typescript-eslint/no-explicit-any */
-    /**
-     * @method filterResults
-     * @param {ApiResponse} res
-     * @param {Array<string> | undefined} types
-     * @returns {Array<any>}
-     * @description Filters the results based on the specified result types.
-     */
-    filterResults(res, types) {
-        const output = [];
-        for (const task of res.tasks || []) {
-            for (const result of task.result || []) {
-                for (const item of result.items || []) {
-                    if (types === undefined ||
-                        types.length === 0 ||
-                        types.includes(item.type)) {
-                        const newItem = this.cleanupUnnecessaryItems(item);
-                        if (Object.keys(newItem).length !== 0) {
-                            output.push(newItem);
-                        }
-                    }
-                    if (this.topCount !== undefined && output.length >= this.topCount) {
-                        break;
-                    }
-                }
-            }
-        }
-        return output;
-    }
-    /* eslint-disable @typescript-eslint/no-explicit-any */
-    /* eslint-disable no-param-reassign */
-    /**
-     * @method cleanupUnnecessaryItems
-     * @param {any} d
-     * @description Removes unnecessary items from the response.
-     */
-    cleanupUnnecessaryItems(d) {
-        if (Array.isArray(d)) {
-            return d.map((item) => this.cleanupUnnecessaryItems(item));
-        }
-        const toRemove = ["xpath", "position", "rectangle"];
-        if (typeof d === "object" && d !== null) {
-            return Object.keys(d).reduce((newObj, key) => {
-                if ((this.jsonResultFields === undefined ||
-                    this.jsonResultFields.includes(key)) &&
-                    !toRemove.includes(key)) {
-                    if (typeof d[key] === "object" && d[key] !== null) {
-                        newObj[key] = this.cleanupUnnecessaryItems(d[key]);
-                    }
-                    else {
-                        newObj[key] = d[key];
-                    }
-                }
-                return newObj;
-            }, {});
-        }
-        return d;
-    }
-    /**
-     * @method processResponse
-     * @param {ApiResponse} res
-     * @returns {string}
-     * @description Processes the response to extract meaningful data.
-     */
-    processResponse(res) {
-        let returnValue = "No good search result found";
-        for (const task of res.tasks || []) {
-            for (const result of task.result || []) {
-                const { item_types } = result;
-                const items = result.items || [];
-                if (item_types.includes("answer_box")) {
-                    returnValue = items.find((item) => item.type === "answer_box").text;
-                }
-                else if (item_types.includes("knowledge_graph")) {
-                    returnValue = items.find((item) => item.type === "knowledge_graph").description;
-                }
-                else if (item_types.includes("featured_snippet")) {
-                    returnValue = items.find((item) => item.type === "featured_snippet").description;
-                }
-                else if (item_types.includes("shopping")) {
-                    returnValue = items.find((item) => item.type === "shopping").price;
-                }
-                else if (item_types.includes("organic")) {
-                    returnValue = items.find((item) => item.type === "organic").description;
-                }
-                if (returnValue) {
-                    break;
-                }
-            }
-        }
-        return returnValue;
-    }
-}
-exports.DataForSeoAPISearch = DataForSeoAPISearch;
+__exportStar(require("@langchain/community/tools/dataforseo_api_search"), exports);

package/dist/tools/dataforseo_api_search.d.ts

@@ -1,170 +1 @@
-import { Tool } from "./base.js";
-/**
- * @interface DataForSeoApiConfig
- * @description Represents the configuration object used to set up a DataForSeoAPISearch instance.
- */
-export interface DataForSeoApiConfig {
-    /**
-     * @property apiLogin
-     * @type {string}
-     * @description The API login credential for DataForSEO. If not provided, it will be fetched from environment variables.
-     */
-    apiLogin?: string;
-    /**
-     * @property apiPassword
-     * @type {string}
-     * @description The API password credential for DataForSEO. If not provided, it will be fetched from environment variables.
-     */
-    apiPassword?: string;
-    /**
-     * @property params
-     * @type {Record<string, string | number | boolean>}
-     * @description Additional parameters to customize the API request.
-     */
-    params?: Record<string, string | number | boolean>;
-    /**
-     * @property useJsonOutput
-     * @type {boolean}
-     * @description Determines if the output should be in JSON format.
-     */
-    useJsonOutput?: boolean;
-    /**
-     * @property jsonResultTypes
-     * @type {Array<string>}
-     * @description Specifies the types of results to include in the output.
-     */
-    jsonResultTypes?: Array<string>;
-    /**
-     * @property jsonResultFields
-     * @type {Array<string>}
-     * @description Specifies the fields to include in each result object.
-     */
-    jsonResultFields?: Array<string>;
-    /**
-     * @property topCount
-     * @type {number}
-     * @description Specifies the maximum number of results to return.
-     */
-    topCount?: number;
-}
-/**
- * Represents a task in the API response.
- */
-type Task = {
-    id: string;
-    status_code: number;
-    status_message: string;
-    time: string;
-    result: Result[];
-};
-/**
- * Represents a result in the API response.
- */
-type Result = {
-    keyword: string;
-    check_url: string;
-    datetime: string;
-    spell?: string;
-    item_types: string[];
-    se_results_count: number;
-    items_count: number;
-    items: any[];
-};
-/**
- * Represents the API response.
- */
-type ApiResponse = {
-    status_code: number;
-    status_message: string;
-    tasks: Task[];
-};
-/**
- * @class DataForSeoAPISearch
- * @extends {Tool}
- * @description Represents a wrapper class to work with DataForSEO SERP API.
- */
-export declare class DataForSeoAPISearch extends Tool {
-    static lc_name(): string;
-    name: string;
-    description: string;
-    protected apiLogin: string;
-    protected apiPassword: string;
-    /**
-     * @property defaultParams
-     * @type {Record<string, string | number | boolean>}
-     * @description These are the default parameters to be used when making an API request.
-     */
-    protected defaultParams: Record<string, string | number | boolean>;
-    protected params: Record<string, string | number | boolean>;
-    protected jsonResultTypes: Array<string> | undefined;
-    protected jsonResultFields: Array<string> | undefined;
-    protected topCount: number | undefined;
-    protected useJsonOutput: boolean;
-    /**
-     * @constructor
-     * @param {DataForSeoApiConfig} config
-     * @description Sets up the class, throws an error if the API login/password isn't provided.
-     */
-    constructor(config?: DataForSeoApiConfig);
-    /**
-     * @method _call
-     * @param {string} keyword
-     * @returns {Promise<string>}
-     * @description Initiates a call to the API and processes the response.
-     */
-    _call(keyword: string): Promise<string>;
-    /**
-     * @method results
-     * @param {string} keyword
-     * @returns {Promise<Array<any>>}
-     * @description Fetches the results from the API for the given keyword.
-     */
-    results(keyword: string): Promise<Array<any>>;
-    /**
-     * @method prepareRequest
-     * @param {string} keyword
-     * @returns {{url: string; headers: HeadersInit; data: BodyInit}}
-     * @description Prepares the request details for the API call.
-     */
-    protected prepareRequest(keyword: string): {
-        url: string;
-        headers: HeadersInit;
-        data: BodyInit;
-    };
-    /**
-     * @method getResponseJson
-     * @param {string} keyword
-     * @returns {Promise<ApiResponse>}
-     * @description Executes a POST request to the provided URL and returns a parsed JSON response.
-     */
-    protected getResponseJson(keyword: string): Promise<ApiResponse>;
-    /**
-     * @method checkResponse
-     * @param {ApiResponse} response
-     * @returns {ApiResponse}
-     * @description Checks the response status code.
-     */
-    private checkResponse;
-    /**
-     * @method filterResults
-     * @param {ApiResponse} res
-     * @param {Array<string> | undefined} types
-     * @returns {Array<any>}
-     * @description Filters the results based on the specified result types.
-     */
-    private filterResults;
-    /**
-     * @method cleanupUnnecessaryItems
-     * @param {any} d
-     * @description Removes unnecessary items from the response.
-     */
-    private cleanupUnnecessaryItems;
-    /**
-     * @method processResponse
-     * @param {ApiResponse} res
-     * @returns {string}
-     * @description Processes the response to extract meaningful data.
-     */
-    protected processResponse(res: ApiResponse): string;
-}
-export {};
+export * from "@langchain/community/tools/dataforseo_api_search";