langchain 0.2.17 → 0.3.0-rc.0

package/dist/document_loaders/web/confluence.js

@@ -1,186 +0,0 @@
-import { htmlToText } from "html-to-text";
-import { Document } from "@langchain/core/documents";
-import { BaseDocumentLoader } from "../base.js";
-import { logVersion020MigrationWarning } from "../../util/entrypoint_deprecation.js";
-/* #__PURE__ */ logVersion020MigrationWarning({
-    oldEntrypointName: "document_loaders/web/confluence",
-    newPackageName: "@langchain/community",
-});
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/confluence" instead. This entrypoint will be removed in 0.3.0.
- *
- * Class representing a document loader for loading pages from Confluence.
- * @example
- * ```typescript
- * const loader = new ConfluencePagesLoader({
- *   baseUrl: "https:
- *   spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
- *   username: "your-username",
- *   accessToken: "your-access-token",
- * });
- * const documents = await loader.load();
- * console.log(documents);
- * ```
- */
-export class ConfluencePagesLoader extends BaseDocumentLoader {
-    constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, expand = "body.storage,version", personalAccessToken, }) {
-        super();
-        Object.defineProperty(this, "baseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "spaceKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "username", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "accessToken", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "limit", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * expand parameter for confluence rest api
-         * description can be found at https://developer.atlassian.com/server/confluence/expansions-in-the-rest-api/
-         */
-        Object.defineProperty(this, "expand", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "personalAccessToken", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.baseUrl = baseUrl;
-        this.spaceKey = spaceKey;
-        this.username = username;
-        this.accessToken = accessToken;
-        this.limit = limit;
-        this.expand = expand;
-        this.personalAccessToken = personalAccessToken;
-    }
-    /**
-     * Returns the authorization header for the request.
-     * @returns The authorization header as a string, or undefined if no credentials were provided.
-     */
-    get authorizationHeader() {
-        if (this.personalAccessToken) {
-            return `Bearer ${this.personalAccessToken}`;
-        }
-        else if (this.username && this.accessToken) {
-            const authToken = Buffer.from(`${this.username}:${this.accessToken}`).toString("base64");
-            return `Basic ${authToken}`;
-        }
-        return undefined;
-    }
-    /**
-     * Fetches all the pages in the specified space and converts each page to
-     * a Document instance.
-     * @param options the extra options of the load function
-     * @param options.limit The limit parameter to overwrite the size to fetch pages.
-     * @param options.start The start parameter to set inital offset to fetch pages.
-     * @returns Promise resolving to an array of Document instances.
-     */
-    async load(options) {
-        try {
-            const pages = await this.fetchAllPagesInSpace(options?.start, options?.limit);
-            return pages.map((page) => this.createDocumentFromPage(page));
-        }
-        catch (error) {
-            console.error("Error:", error);
-            return [];
-        }
-    }
-    /**
-     * Fetches data from the Confluence API using the provided URL.
-     * @param url The URL to fetch data from.
-     * @returns Promise resolving to the JSON response from the API.
-     */
-    async fetchConfluenceData(url) {
-        try {
-            const initialHeaders = {
-                "Content-Type": "application/json",
-                Accept: "application/json",
-            };
-            const authHeader = this.authorizationHeader;
-            if (authHeader) {
-                initialHeaders.Authorization = authHeader;
-            }
-            const response = await fetch(url, {
-                headers: initialHeaders,
-            });
-            if (!response.ok) {
-                throw new Error(`Failed to fetch ${url} from Confluence: ${response.status}`);
-            }
-            return await response.json();
-        }
-        catch (error) {
-            throw new Error(`Failed to fetch ${url} from Confluence: ${error}`);
-        }
-    }
-    /**
-     * Recursively fetches all the pages in the specified space.
-     * @param start The start parameter to paginate through the results.
-     * @returns Promise resolving to an array of ConfluencePage objects.
-     */
-    async fetchAllPagesInSpace(start = 0, limit = this.limit) {
-        const url = `${this.baseUrl}/rest/api/content?spaceKey=${this.spaceKey}&limit=${limit}&start=${start}&expand=${this.expand}`;
-        const data = await this.fetchConfluenceData(url);
-        if (data.size === 0) {
-            return [];
-        }
-        const nextPageStart = start + data.size;
-        const nextPageResults = await this.fetchAllPagesInSpace(nextPageStart, limit);
-        return data.results.concat(nextPageResults);
-    }
-    /**
-     * Creates a Document instance from a ConfluencePage object.
-     * @param page The ConfluencePage object to convert.
-     * @returns A Document instance.
-     */
-    createDocumentFromPage(page) {
-        // Convert the HTML content to plain text
-        const plainTextContent = htmlToText(page.body.storage.value, {
-            wordwrap: false,
-            preserveNewlines: false,
-        });
-        // Remove empty lines
-        const textWithoutEmptyLines = plainTextContent.replace(/^\s*[\r\n]/gm, "");
-        // Generate the URL
-        const pageUrl = `${this.baseUrl}/spaces/${this.spaceKey}/pages/${page.id}`;
-        // Return a langchain document
-        return new Document({
-            pageContent: textWithoutEmptyLines,
-            metadata: {
-                id: page.id,
-                status: page.status,
-                title: page.title,
-                type: page.type,
-                url: pageUrl,
-                version: page.version?.number,
-                updated_by: page.version?.by?.displayName,
-                updated_at: page.version?.when,
-            },
-        });
-    }
-}

package/dist/document_loaders/web/couchbase.cjs

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CouchbaseDocumentLoader = void 0;
-const documents_1 = require("@langchain/core/documents");
-const base_js_1 = require("../base.cjs");
-const entrypoint_deprecation_js_1 = require("../../util/entrypoint_deprecation.cjs");
-/* #__PURE__ */ (0, entrypoint_deprecation_js_1.logVersion020MigrationWarning)({
-    oldEntrypointName: "document_loaders/web/couchbase",
-    newPackageName: "@langchain/community",
-});
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/couchbase" instead. This entrypoint will be removed in 0.3.0.
- *
- * loader for couchbase document
- */
-class CouchbaseDocumentLoader extends base_js_1.BaseDocumentLoader {
-    /**
-     * construct Couchbase document loader with a requirement for couchbase cluster client
-     * @param client { Cluster } [ couchbase connected client to connect to database ]
-     * @param query { string } [ query to get results from while loading the data ]
-     * @param pageContentFields { Array<string> } [ filters fields of the document and shows these only ]
-     * @param metadataFields { Array<string> } [ metadata fields required ]
-     */
-    constructor(client, query, pageContentFields, metadataFields) {
-        super();
-        Object.defineProperty(this, "cluster", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "query", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "pageContentFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "metadataFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (!client) {
-            throw new Error("Couchbase client cluster must be provided.");
-        }
-        this.cluster = client;
-        this.query = query;
-        this.pageContentFields = pageContentFields;
-        this.metadataFields = metadataFields;
-    }
-    /**
-     * Function to load document based on query from couchbase
-     * @returns {Promise<Document[]>} [ Returns a promise of all the documents as array ]
-     */
-    async load() {
-        const documents = [];
-        for await (const doc of this.lazyLoad()) {
-            documents.push(doc);
-        }
-        return documents;
-    }
-    /**
-     * Function to load documents based on iterator rather than full load
-     * @returns {AsyncIterable<Document>} [ Returns an iterator to fetch documents ]
-     */
-    async *lazyLoad() {
-        // Run SQL++ Query
-        const result = await this.cluster.query(this.query);
-        for await (const row of result.rows) {
-            let { metadataFields, pageContentFields } = this;
-            if (!pageContentFields) {
-                pageContentFields = Object.keys(row);
-            }
-            if (!metadataFields) {
-                metadataFields = [];
-            }
-            const metadata = metadataFields.reduce((obj, field) => ({ ...obj, [field]: row[field] }), {});
-            const document = pageContentFields
-                .map((k) => `${k}: ${JSON.stringify(row[k])}`)
-                .join("\n");
-            yield new documents_1.Document({
-                pageContent: document,
-                metadata,
-            });
-        }
-    }
-}
-exports.CouchbaseDocumentLoader = CouchbaseDocumentLoader;

package/dist/document_loaders/web/couchbase.d.ts

@@ -1,32 +0,0 @@
-import { Cluster } from "couchbase";
-import { Document } from "@langchain/core/documents";
-import { BaseDocumentLoader, DocumentLoader } from "../base.js";
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/couchbase" instead. This entrypoint will be removed in 0.3.0.
- *
- * loader for couchbase document
- */
-export declare class CouchbaseDocumentLoader extends BaseDocumentLoader implements DocumentLoader {
-    private cluster;
-    private query;
-    private pageContentFields?;
-    private metadataFields?;
-    /**
-     * construct Couchbase document loader with a requirement for couchbase cluster client
-     * @param client { Cluster } [ couchbase connected client to connect to database ]
-     * @param query { string } [ query to get results from while loading the data ]
-     * @param pageContentFields { Array<string> } [ filters fields of the document and shows these only ]
-     * @param metadataFields { Array<string> } [ metadata fields required ]
-     */
-    constructor(client: Cluster, query: string, pageContentFields?: string[], metadataFields?: string[]);
-    /**
-     * Function to load document based on query from couchbase
-     * @returns {Promise<Document[]>} [ Returns a promise of all the documents as array ]
-     */
-    load(): Promise<Document[]>;
-    /**
-     * Function to load documents based on iterator rather than full load
-     * @returns {AsyncIterable<Document>} [ Returns an iterator to fetch documents ]
-     */
-    lazyLoad(): AsyncIterable<Document>;
-}

package/dist/document_loaders/web/couchbase.js

@@ -1,91 +0,0 @@
-import { Document } from "@langchain/core/documents";
-import { BaseDocumentLoader } from "../base.js";
-import { logVersion020MigrationWarning } from "../../util/entrypoint_deprecation.js";
-/* #__PURE__ */ logVersion020MigrationWarning({
-    oldEntrypointName: "document_loaders/web/couchbase",
-    newPackageName: "@langchain/community",
-});
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/couchbase" instead. This entrypoint will be removed in 0.3.0.
- *
- * loader for couchbase document
- */
-export class CouchbaseDocumentLoader extends BaseDocumentLoader {
-    /**
-     * construct Couchbase document loader with a requirement for couchbase cluster client
-     * @param client { Cluster } [ couchbase connected client to connect to database ]
-     * @param query { string } [ query to get results from while loading the data ]
-     * @param pageContentFields { Array<string> } [ filters fields of the document and shows these only ]
-     * @param metadataFields { Array<string> } [ metadata fields required ]
-     */
-    constructor(client, query, pageContentFields, metadataFields) {
-        super();
-        Object.defineProperty(this, "cluster", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "query", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "pageContentFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "metadataFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (!client) {
-            throw new Error("Couchbase client cluster must be provided.");
-        }
-        this.cluster = client;
-        this.query = query;
-        this.pageContentFields = pageContentFields;
-        this.metadataFields = metadataFields;
-    }
-    /**
-     * Function to load document based on query from couchbase
-     * @returns {Promise<Document[]>} [ Returns a promise of all the documents as array ]
-     */
-    async load() {
-        const documents = [];
-        for await (const doc of this.lazyLoad()) {
-            documents.push(doc);
-        }
-        return documents;
-    }
-    /**
-     * Function to load documents based on iterator rather than full load
-     * @returns {AsyncIterable<Document>} [ Returns an iterator to fetch documents ]
-     */
-    async *lazyLoad() {
-        // Run SQL++ Query
-        const result = await this.cluster.query(this.query);
-        for await (const row of result.rows) {
-            let { metadataFields, pageContentFields } = this;
-            if (!pageContentFields) {
-                pageContentFields = Object.keys(row);
-            }
-            if (!metadataFields) {
-                metadataFields = [];
-            }
-            const metadata = metadataFields.reduce((obj, field) => ({ ...obj, [field]: row[field] }), {});
-            const document = pageContentFields
-                .map((k) => `${k}: ${JSON.stringify(row[k])}`)
-                .join("\n");
-            yield new Document({
-                pageContent: document,
-                metadata,
-            });
-        }
-    }
-}

package/dist/document_loaders/web/figma.cjs

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FigmaFileLoader = void 0;
-const documents_1 = require("@langchain/core/documents");
-const env_1 = require("@langchain/core/utils/env");
-const base_js_1 = require("../base.cjs");
-const entrypoint_deprecation_js_1 = require("../../util/entrypoint_deprecation.cjs");
-/* #__PURE__ */ (0, entrypoint_deprecation_js_1.logVersion020MigrationWarning)({
-    oldEntrypointName: "document_loaders/web/figma",
-    newPackageName: "@langchain/community",
-});
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/figma" instead. This entrypoint will be removed in 0.3.0.
- *
- * Class representing a document loader for loading Figma files. It
- * extends the BaseDocumentLoader and implements the FigmaLoaderParams
- * interface. The constructor takes a config object as a parameter, which
- * contains the access token, an array of node IDs, and the file key.
- * @example
- * ```typescript
- * const loader = new FigmaFileLoader({
- *   accessToken: "FIGMA_ACCESS_TOKEN",
- *   nodeIds: ["id1", "id2", "id3"],
- *   fileKey: "key",
- * });
- * const docs = await loader.load();
- * ```
- */
-class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
-    constructor({ accessToken = (0, env_1.getEnvironmentVariable)("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
-        super();
-        Object.defineProperty(this, "accessToken", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "nodeIds", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "fileKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "headers", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        this.accessToken = accessToken;
-        this.nodeIds = nodeIds;
-        this.fileKey = fileKey;
-        if (this.accessToken) {
-            this.headers = {
-                "x-figma-token": this.accessToken,
-            };
-        }
-    }
-    /**
-     * Constructs the URL for the Figma API call.
-     * @returns The constructed URL as a string.
-     */
-    constructFigmaApiURL() {
-        return `https://api.figma.com/v1/files/${this.fileKey}/nodes?ids=${this.nodeIds.join(",")}`;
-    }
-    /**
-     * Fetches the Figma file using the Figma API and returns it as a
-     * FigmaFile object.
-     * @returns A Promise that resolves to a FigmaFile object.
-     */
-    async getFigmaFile() {
-        const url = this.constructFigmaApiURL();
-        const response = await fetch(url, { headers: this.headers });
-        const data = await response.json();
-        if (!response.ok) {
-            throw new Error(`Unable to get figma file: ${response.status} ${JSON.stringify(data)}`);
-        }
-        if (!data) {
-            throw new Error("Unable to get file");
-        }
-        return data;
-    }
-    /**
-     * Fetches the Figma file using the Figma API, creates a Document instance
-     * with the JSON representation of the file as the page content and the
-     * API URL as the metadata, and returns it.
-     * @returns A Promise that resolves to an array of Document instances.
-     */
-    async load() {
-        const data = await this.getFigmaFile();
-        const text = JSON.stringify(data);
-        const metadata = { source: this.constructFigmaApiURL() };
-        return [new documents_1.Document({ pageContent: text, metadata })];
-    }
-}
-exports.FigmaFileLoader = FigmaFileLoader;

package/dist/document_loaders/web/figma.d.ts

@@ -1,82 +0,0 @@
-import { Document } from "@langchain/core/documents";
-import { BaseDocumentLoader } from "../base.js";
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/figma" instead. This entrypoint will be removed in 0.3.0.
- *
- * Interface representing a Figma file. It includes properties for the
- * file name, role, last modified date, editor type, thumbnail URL,
- * version, document node, schema version, main file key, and an array of
- * branches.
- */
-export interface FigmaFile {
-    name: string;
-    role: string;
-    lastModified: string;
-    editorType: string;
-    thumbnailUrl: string;
-    version: string;
-    document: Node;
-    schemaVersion: number;
-    mainFileKey: string;
-    branches: Array<{
-        key: string;
-        name: string;
-        thumbnail_url: string;
-        last_modified: string;
-        link_access: string;
-    }>;
-}
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/figma" instead. This entrypoint will be removed in 0.3.0.
- *
- * Interface representing the parameters for configuring the FigmaLoader.
- * It includes optional properties for the access token, an array of node
- * IDs, and the file key.
- */
-export interface FigmaLoaderParams {
-    accessToken?: string;
-    nodeIds: string[];
-    fileKey: string;
-}
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/figma" instead. This entrypoint will be removed in 0.3.0.
- *
- * Class representing a document loader for loading Figma files. It
- * extends the BaseDocumentLoader and implements the FigmaLoaderParams
- * interface. The constructor takes a config object as a parameter, which
- * contains the access token, an array of node IDs, and the file key.
- * @example
- * ```typescript
- * const loader = new FigmaFileLoader({
- *   accessToken: "FIGMA_ACCESS_TOKEN",
- *   nodeIds: ["id1", "id2", "id3"],
- *   fileKey: "key",
- * });
- * const docs = await loader.load();
- * ```
- */
-export declare class FigmaFileLoader extends BaseDocumentLoader implements FigmaLoaderParams {
-    accessToken?: string;
-    nodeIds: string[];
-    fileKey: string;
-    private headers;
-    constructor({ accessToken, nodeIds, fileKey, }: FigmaLoaderParams);
-    /**
-     * Constructs the URL for the Figma API call.
-     * @returns The constructed URL as a string.
-     */
-    private constructFigmaApiURL;
-    /**
-     * Fetches the Figma file using the Figma API and returns it as a
-     * FigmaFile object.
-     * @returns A Promise that resolves to a FigmaFile object.
-     */
-    private getFigmaFile;
-    /**
-     * Fetches the Figma file using the Figma API, creates a Document instance
-     * with the JSON representation of the file as the page content and the
-     * API URL as the metadata, and returns it.
-     * @returns A Promise that resolves to an array of Document instances.
-     */
-    load(): Promise<Document[]>;
-}

package/dist/document_loaders/web/figma.js

@@ -1,98 +0,0 @@
-import { Document } from "@langchain/core/documents";
-import { getEnvironmentVariable } from "@langchain/core/utils/env";
-import { BaseDocumentLoader } from "../base.js";
-import { logVersion020MigrationWarning } from "../../util/entrypoint_deprecation.js";
-/* #__PURE__ */ logVersion020MigrationWarning({
-    oldEntrypointName: "document_loaders/web/figma",
-    newPackageName: "@langchain/community",
-});
-/**
- * @deprecated - Import from "@langchain/community/document_loaders/web/figma" instead. This entrypoint will be removed in 0.3.0.
- *
- * Class representing a document loader for loading Figma files. It
- * extends the BaseDocumentLoader and implements the FigmaLoaderParams
- * interface. The constructor takes a config object as a parameter, which
- * contains the access token, an array of node IDs, and the file key.
- * @example
- * ```typescript
- * const loader = new FigmaFileLoader({
- *   accessToken: "FIGMA_ACCESS_TOKEN",
- *   nodeIds: ["id1", "id2", "id3"],
- *   fileKey: "key",
- * });
- * const docs = await loader.load();
- * ```
- */
-export class FigmaFileLoader extends BaseDocumentLoader {
-    constructor({ accessToken = getEnvironmentVariable("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
-        super();
-        Object.defineProperty(this, "accessToken", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "nodeIds", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "fileKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "headers", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        this.accessToken = accessToken;
-        this.nodeIds = nodeIds;
-        this.fileKey = fileKey;
-        if (this.accessToken) {
-            this.headers = {
-                "x-figma-token": this.accessToken,
-            };
-        }
-    }
-    /**
-     * Constructs the URL for the Figma API call.
-     * @returns The constructed URL as a string.
-     */
-    constructFigmaApiURL() {
-        return `https://api.figma.com/v1/files/${this.fileKey}/nodes?ids=${this.nodeIds.join(",")}`;
-    }
-    /**
-     * Fetches the Figma file using the Figma API and returns it as a
-     * FigmaFile object.
-     * @returns A Promise that resolves to a FigmaFile object.
-     */
-    async getFigmaFile() {
-        const url = this.constructFigmaApiURL();
-        const response = await fetch(url, { headers: this.headers });
-        const data = await response.json();
-        if (!response.ok) {
-            throw new Error(`Unable to get figma file: ${response.status} ${JSON.stringify(data)}`);
-        }
-        if (!data) {
-            throw new Error("Unable to get file");
-        }
-        return data;
-    }
-    /**
-     * Fetches the Figma file using the Figma API, creates a Document instance
-     * with the JSON representation of the file as the page content and the
-     * API URL as the metadata, and returns it.
-     * @returns A Promise that resolves to an array of Document instances.
-     */
-    async load() {
-        const data = await this.getFigmaFile();
-        const text = JSON.stringify(data);
-        const metadata = { source: this.constructFigmaApiURL() };
-        return [new Document({ pageContent: text, metadata })];
-    }
-}