langchain 0.0.130 → 0.0.132

package/dist/document_loaders/web/notionapi.cjs

@@ -6,6 +6,10 @@ const notion_to_md_1 = require("notion-to-md");
 const notion_js_1 = require("notion-to-md/build/utils/notion.js");
 const base_js_1 = require("../base.cjs");
 const document_js_1 = require("../../document.cjs");
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading documents from Notion using the Notion API.
+ */
 class NotionAPILoader extends base_js_1.BaseDocumentLoader {
     constructor(options) {
         super();
@@ -41,6 +45,12 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
         this.id = options.id;
         this.type = options.type;
     }
+    /**
+     * Parses the properties of a Notion page and returns them as key-value
+     * pairs.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed properties as key-value pairs.
+     */
     parsePageProperties(page) {
         return Object.fromEntries(Object.entries(page.properties).map(([_, prop]) => {
             switch (prop.type) {
@@ -97,6 +107,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
             }
         }));
     }
+    /**
+     * Parses the details of a Notion page and returns them as an object.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed details of the page.
+     */
     parsePageDetails(page) {
         const metadata = Object.fromEntries(Object.entries(page).filter(([key, _]) => key !== "id"));
         return {
@@ -105,6 +120,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
             properties: this.parsePageProperties(page),
         };
     }
+    /**
+     * Loads a Notion block and returns it as an MdBlock object.
+     * @param block The Notion block to load.
+     * @returns A Promise that resolves to an MdBlock object.
+     */
     async loadBlock(block) {
         return {
             type: block.type,
@@ -113,6 +133,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
             children: [],
         };
     }
+    /**
+     * Loads Notion blocks and their child documents recursively.
+     * @param blocksResponse The response from the Notion API containing the blocks to load.
+     * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
+     */
     async loadBlocksAndDocs(blocksResponse) {
         const blocks = blocksResponse.filter(client_1.isFullBlock);
         const [childPageDocuments, childDatabaseDocuments, blocksDocsArray] = await Promise.all([
@@ -157,6 +182,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
             ],
         };
     }
+    /**
+     * Loads a Notion page and its child documents.
+     * @param page The Notion page or page ID to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async loadPage(page) {
         // Check page is a page ID or a GetPageResponse
         const [pageData, pageId] = typeof page === "string"
@@ -176,6 +206,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
         });
         return [pageDocument, ...childDocuments];
     }
+    /**
+     * Loads a Notion database and its documents.
+     * @param id The ID of the Notion database to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async loadDatabase(id) {
         const documents = [];
         try {
@@ -193,6 +228,10 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
         }
         return documents;
     }
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async load() {
         const documents = [];
         switch (this.type) {

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

@@ -1,23 +1,66 @@
 import { Client } from "@notionhq/client";
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
+/**
+ * Represents the type of Notion API to load documents from. The options
+ * are "database" or "page".
+ */
 export type NotionAPIType = "database" | "page";
 export type NotionAPILoaderOptions = {
     clientOptions: ConstructorParameters<typeof Client>[0];
     id: string;
     type: NotionAPIType;
 };
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading documents from Notion using the Notion API.
+ */
 export declare class NotionAPILoader extends BaseDocumentLoader {
     private notionClient;
     private n2mClient;
     private id;
     private type;
     constructor(options: NotionAPILoaderOptions);
+    /**
+     * Parses the properties of a Notion page and returns them as key-value
+     * pairs.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed properties as key-value pairs.
+     */
     private parsePageProperties;
+    /**
+     * Parses the details of a Notion page and returns them as an object.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed details of the page.
+     */
     private parsePageDetails;
+    /**
+     * Loads a Notion block and returns it as an MdBlock object.
+     * @param block The Notion block to load.
+     * @returns A Promise that resolves to an MdBlock object.
+     */
     private loadBlock;
+    /**
+     * Loads Notion blocks and their child documents recursively.
+     * @param blocksResponse The response from the Notion API containing the blocks to load.
+     * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
+     */
     private loadBlocksAndDocs;
+    /**
+     * Loads a Notion page and its child documents.
+     * @param page The Notion page or page ID to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     private loadPage;
+    /**
+     * Loads a Notion database and its documents.
+     * @param id The ID of the Notion database to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     private loadDatabase;
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/notionapi.js

@@ -3,6 +3,10 @@ import { NotionToMarkdown } from "notion-to-md";
 import { getBlockChildren } from "notion-to-md/build/utils/notion.js";
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading documents from Notion using the Notion API.
+ */
 export class NotionAPILoader extends BaseDocumentLoader {
     constructor(options) {
         super();
@@ -38,6 +42,12 @@ export class NotionAPILoader extends BaseDocumentLoader {
         this.id = options.id;
         this.type = options.type;
     }
+    /**
+     * Parses the properties of a Notion page and returns them as key-value
+     * pairs.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed properties as key-value pairs.
+     */
     parsePageProperties(page) {
         return Object.fromEntries(Object.entries(page.properties).map(([_, prop]) => {
             switch (prop.type) {
@@ -94,6 +104,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
             }
         }));
     }
+    /**
+     * Parses the details of a Notion page and returns them as an object.
+     * @param page The Notion page to parse.
+     * @returns An object containing the parsed details of the page.
+     */
     parsePageDetails(page) {
         const metadata = Object.fromEntries(Object.entries(page).filter(([key, _]) => key !== "id"));
         return {
@@ -102,6 +117,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
             properties: this.parsePageProperties(page),
         };
     }
+    /**
+     * Loads a Notion block and returns it as an MdBlock object.
+     * @param block The Notion block to load.
+     * @returns A Promise that resolves to an MdBlock object.
+     */
     async loadBlock(block) {
         return {
             type: block.type,
@@ -110,6 +130,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
             children: [],
         };
     }
+    /**
+     * Loads Notion blocks and their child documents recursively.
+     * @param blocksResponse The response from the Notion API containing the blocks to load.
+     * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
+     */
     async loadBlocksAndDocs(blocksResponse) {
         const blocks = blocksResponse.filter(isFullBlock);
         const [childPageDocuments, childDatabaseDocuments, blocksDocsArray] = await Promise.all([
@@ -154,6 +179,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
             ],
         };
     }
+    /**
+     * Loads a Notion page and its child documents.
+     * @param page The Notion page or page ID to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async loadPage(page) {
         // Check page is a page ID or a GetPageResponse
         const [pageData, pageId] = typeof page === "string"
@@ -173,6 +203,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
         });
         return [pageDocument, ...childDocuments];
     }
+    /**
+     * Loads a Notion database and its documents.
+     * @param id The ID of the Notion database to load.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async loadDatabase(id) {
         const documents = [];
         try {
@@ -190,6 +225,10 @@ export class NotionAPILoader extends BaseDocumentLoader {
         }
         return documents;
     }
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns A Promise that resolves to an array of Documents.
+     */
     async load() {
         const documents = [];
         switch (this.type) {

package/dist/document_loaders/web/notiondb.cjs

@@ -51,6 +51,10 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
             "Notion-Version": notionApiVersion,
         };
     }
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns An array of Document objects.
+     */
     async load() {
         const pageIds = await this.retrievePageIds();
         const documents = [];
@@ -59,6 +63,10 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
         }
         return documents;
     }
+    /**
+     * Retrieves the IDs of the pages in the Notion database.
+     * @returns An array of page IDs.
+     */
     async retrievePageIds() {
         const url = `${NOTION_BASE_URL}/databases/${this.databaseId}/query`;
         const pageIds = [];
@@ -83,6 +91,11 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
         }
         return pageIds;
     }
+    /**
+     * Loads a Notion page and returns it as a Document object.
+     * @param pageId The ID of the Notion page to load.
+     * @returns A Document object representing the loaded Notion page.
+     */
     async loadPage(pageId) {
         const url = `${NOTION_BASE_URL}/pages/${pageId}`;
         const response = await fetch(url, { method: "GET", headers: this.headers });
@@ -132,6 +145,12 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
             metadata,
         };
     }
+    /**
+     * Loads the blocks of a Notion page and returns them as a string.
+     * @param blockId The ID of the block to load.
+     * @param numberOfTabs The number of tabs to use for indentation.
+     * @returns A string representing the loaded blocks.
+     */
     async loadBlocks(blockId, numberOfTabs = 0) {
         const resultLinesArr = [];
         let currentBlockId = blockId;

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

@@ -1,5 +1,10 @@
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
+/**
+ * Interface representing the parameters for the NotionDBLoader class. It
+ * includes the database ID, Notion integration token, Notion API version,
+ * and page size limit.
+ */
 export interface NotionDBLoaderParams {
     databaseId: string;
     notionIntegrationToken?: string;
@@ -14,8 +19,27 @@ export declare class NotionDBLoader extends BaseDocumentLoader implements Notion
     pageSizeLimit: number;
     private headers;
     constructor({ databaseId, notionApiVersion, notionIntegrationToken, pageSizeLimit, }: NotionDBLoaderParams);
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns An array of Document objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Retrieves the IDs of the pages in the Notion database.
+     * @returns An array of page IDs.
+     */
     private retrievePageIds;
+    /**
+     * Loads a Notion page and returns it as a Document object.
+     * @param pageId The ID of the Notion page to load.
+     * @returns A Document object representing the loaded Notion page.
+     */
     private loadPage;
+    /**
+     * Loads the blocks of a Notion page and returns them as a string.
+     * @param blockId The ID of the block to load.
+     * @param numberOfTabs The number of tabs to use for indentation.
+     * @returns A string representing the loaded blocks.
+     */
     private loadBlocks;
 }

package/dist/document_loaders/web/notiondb.js

@@ -48,6 +48,10 @@ export class NotionDBLoader extends BaseDocumentLoader {
             "Notion-Version": notionApiVersion,
         };
     }
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns An array of Document objects.
+     */
     async load() {
         const pageIds = await this.retrievePageIds();
         const documents = [];
@@ -56,6 +60,10 @@ export class NotionDBLoader extends BaseDocumentLoader {
         }
         return documents;
     }
+    /**
+     * Retrieves the IDs of the pages in the Notion database.
+     * @returns An array of page IDs.
+     */
     async retrievePageIds() {
         const url = `${NOTION_BASE_URL}/databases/${this.databaseId}/query`;
         const pageIds = [];
@@ -80,6 +88,11 @@ export class NotionDBLoader extends BaseDocumentLoader {
         }
         return pageIds;
     }
+    /**
+     * Loads a Notion page and returns it as a Document object.
+     * @param pageId The ID of the Notion page to load.
+     * @returns A Document object representing the loaded Notion page.
+     */
     async loadPage(pageId) {
         const url = `${NOTION_BASE_URL}/pages/${pageId}`;
         const response = await fetch(url, { method: "GET", headers: this.headers });
@@ -129,6 +142,12 @@ export class NotionDBLoader extends BaseDocumentLoader {
             metadata,
         };
     }
+    /**
+     * Loads the blocks of a Notion page and returns them as a string.
+     * @param blockId The ID of the block to load.
+     * @param numberOfTabs The number of tabs to use for indentation.
+     * @returns A string representing the loaded blocks.
+     */
     async loadBlocks(blockId, numberOfTabs = 0) {
         const resultLinesArr = [];
         let currentBlockId = blockId;

package/dist/document_loaders/web/playwright.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightWebBaseLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 class PlaywrightWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -38,14 +43,31 @@ class PlaywrightWebBaseLoader extends base_js_1.BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PlaywrightWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new document_js_1.Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static async imports() {
         try {
             const { chromium } = await import("playwright");

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

@@ -8,19 +8,46 @@ export type PlaywrightGotoOptions = {
     timeout?: number;
     waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit";
 };
+/**
+ * Type representing a function for evaluating JavaScript code on a web
+ * page using Playwright. Takes a Page, Browser, and Response object as
+ * parameters and returns a Promise that resolves to a string.
+ */
 export type PlaywrightEvaluate = (page: Page, browser: Browser, response: Response | null) => Promise<string>;
 export type PlaywrightWebBaseLoaderOptions = {
     launchOptions?: LaunchOptions;
     gotoOptions?: PlaywrightGotoOptions;
     evaluate?: PlaywrightEvaluate;
 };
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 export declare class PlaywrightWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;
     options: PlaywrightWebBaseLoaderOptions | undefined;
     constructor(webPath: string, options?: PlaywrightWebBaseLoaderOptions);
     static _scrape(url: string, options?: PlaywrightWebBaseLoaderOptions): Promise<string>;
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     scrape(): Promise<string>;
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static imports(): Promise<{
         chromium: typeof import("playwright").chromium;
     }>;

package/dist/document_loaders/web/playwright.js

@@ -1,5 +1,10 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 export class PlaywrightWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -35,14 +40,31 @@ export class PlaywrightWebBaseLoader extends BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PlaywrightWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static async imports() {
         try {
             const { chromium } = await import("playwright");

package/dist/document_loaders/web/puppeteer.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PuppeteerWebBaseLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -40,14 +45,29 @@ class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PuppeteerWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new document_js_1.Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static async imports() {
         try {
             // eslint-disable-next-line import/no-extraneous-dependencies

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

@@ -7,19 +7,44 @@ export type PuppeteerGotoOptions = WaitForOptions & {
     referer?: string;
     referrerPolicy?: string;
 };
+/**
+ * Type representing a function for evaluating JavaScript code on a web
+ * page using Puppeteer. It takes a Page and Browser object as parameters
+ * and returns a Promise that resolves to a string.
+ */
 export type PuppeteerEvaluate = (page: Page, browser: Browser) => Promise<string>;
 export type PuppeteerWebBaseLoaderOptions = {
     launchOptions?: PuppeteerLaunchOptions;
     gotoOptions?: PuppeteerGotoOptions;
     evaluate?: PuppeteerEvaluate;
 };
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 export declare class PuppeteerWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;
     options: PuppeteerWebBaseLoaderOptions | undefined;
     constructor(webPath: string, options?: PuppeteerWebBaseLoaderOptions);
     static _scrape(url: string, options?: PuppeteerWebBaseLoaderOptions): Promise<string>;
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     scrape(): Promise<string>;
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static imports(): Promise<{
         launch: typeof launch;
     }>;

package/dist/document_loaders/web/puppeteer.js

@@ -1,5 +1,10 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 export class PuppeteerWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -37,14 +42,29 @@ export class PuppeteerWebBaseLoader extends BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PuppeteerWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static async imports() {
         try {
             // eslint-disable-next-line import/no-extraneous-dependencies

package/dist/document_loaders/web/s3.cjs

@@ -31,6 +31,10 @@ const node_stream_1 = require("node:stream");
 const client_s3_1 = require("@aws-sdk/client-s3");
 const base_js_1 = require("../base.cjs");
 const unstructured_js_1 = require("../fs/unstructured.cjs");
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 class S3Loader extends base_js_1.BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = unstructured_js_1.UnstructuredLoader, }) {
         super();
@@ -84,6 +88,11 @@ class S3Loader extends base_js_1.BaseDocumentLoader {
         this._fs = fs;
         this._UnstructuredLoader = UnstructuredLoader;
     }
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     async load() {
         const tempDir = this._fs.mkdtempSync(path.join(os.tmpdir(), "s3fileloader-"));
         const filePath = path.join(tempDir, this.key);