@promptbook/legacy-documents 0.72.0-14 → 0.72.0-23

package/esm/typings/src/_packages/website-crawler.index.d.ts

@@ -1,8 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
-import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
-import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
-export { PROMPTBOOK_VERSION };
-export { createWebsiteScraper };
-export { _WebsiteScraperRegistration };
-export { WebsiteScraper };

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts

@@ -1,29 +0,0 @@
-import type { CsvSettings } from '../../formats/csv/CsvSettings';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-export type CreatePipelineExecutorSettings = Omit<PrepareAndScrapeOptions, 'llmTools'> & {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default MAX_EXECUTION_ATTEMPTS
-     */
-    readonly maxExecutionAttempts: number;
-    /**
-     * Settings for CSV format
-     *
-     * @default DEFAULT_CSV_SETTINGS
-     */
-    readonly csvSettings: CsvSettings;
-    /**
-     * If you pass fully prepared pipeline, this does not matter
-     *
-     * Otherwise:
-     * If false or not set, warning is shown when pipeline is not prepared
-     * If true, warning is suppressed
-     *
-     * @default false
-     */
-    readonly isNotPreparedWarningSupressed: boolean;
-};
-/**
- * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
- */

package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts

@@ -1,47 +0,0 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { Converter } from '../_common/Converter';
-import type { Scraper } from '../_common/Scraper';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
-import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
-/**
- * Scraper for .docx files
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/website-crawler`
- */
-export declare class WebsiteScraper implements Converter, Scraper {
-    private readonly tools;
-    private readonly options;
-    /**
-     * Metadata of the scraper which includes title, mime types, etc.
-     */
-    get metadata(): ScraperAndConverterMetadata;
-    /**
-     * Markdown scraper is used internally
-     */
-    private readonly markdownScraper;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
-    /**
-     * Convert the website  to `.md` file and returns intermediate source
-     *
-     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
-     */
-    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource & {
-        markdown: string_markdown;
-    }>;
-    /**
-     * Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
-}
-/**
- * TODO: !!!!!! Put into separate package
- * TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
- * TODO: [🪂] Do it in parallel 11:11
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -1,20 +0,0 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { WebsiteScraper } from './WebsiteScraper';
-/**
- * @@@
- *
- * @public exported from `@promptbook/website-crawler`
- */
-export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => WebsiteScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
-    requiredExecutables: string[];
-}>;
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts

@@ -1,5 +0,0 @@
-#!/usr/bin/env ts-node
-export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

package/esm/typings/src/scrapers/website/register-constructor.d.ts

@@ -1,13 +0,0 @@
-import type { Registration } from '../../utils/$Register';
-/**
- * Registration of known scraper
- *
- * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
- *
- * @public exported from `@promptbook/website-crawler`
- * @public exported from `@promptbook/cli`
- */
-export declare const _WebsiteScraperRegistration: Registration;
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -1,24 +0,0 @@
-import type { Registration } from '../../utils/$Register';
-/**
- * Metadata of the scraper
- *
- * @private within the scraper directory
- */
-export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
-    requiredExecutables: string[];
-}>;
-/**
- * Registration of known scraper metadata
- *
- * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
- *
- * @public exported from `@promptbook/core`
- * @public exported from `@promptbook/cli`
- */
-export declare const _WebsiteScraperMetadataRegistration: Registration;

package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts

@@ -1,12 +0,0 @@
-import { Converter } from 'showdown';
-/**
- * A converter instance that uses showdown and highlight extensions
- *
- * @type {Converter}
- * @private for markdown and html knowledge scrapers
- */
-export declare const markdownConverter: Converter;
-/**
- * TODO: !!!!!! Figure out better name not to confuse with `Converter`
- * TODO: !!!!!! Lazy-make converter
- */