@promptbook/openai 0.72.0-8 → 0.72.0

package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.d.ts

@@ -1,37 +0,0 @@
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
-/**
- * Scraper for .docx files
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/core`
- */
-export declare const legacyDocumentScraper: {
-    /**
-     * Mime types that this scraper can handle
-     */
-    mimeTypes: string[];
-    /**
-     * Link to documentation
-     */
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    /**
-     * Convert the `.doc` or `.rtf`  to `.doc` 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, options: PrepareAndScrapeOptions): Promise<ScraperIntermediateSource>;
-    /**
-     * Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
-};
-/**
- * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
- * TODO: [🦖] Make some system for putting scrapers to separete packages
- * TODO: [🪂] Do it in parallel 11:11
- * TODO: [🦷] Ideally use `as const satisfies Converter & Scraper` BUT this combination throws errors
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/typings/src/scrapers/index.d.ts

@@ -1,8 +0,0 @@
-import type { Scraper } from './_common/Scraper';
-/**
- * @@@
- *
- * @private because this will be replaced by a system of one scraper per package [🦖]
- * TODO: [🦖] System for scrapers NOT public exported from `@promptbook/core`
- */
-export declare const SCRAPERS: Array<Scraper>;

package/esm/typings/src/scrapers/markdown/markdownScraper.d.ts

@@ -1,29 +0,0 @@
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-/**
- * Scraper for markdown files
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/core`
- */
-export declare const markdownScraper: {
-    /**
-     * Mime types that this scraper can handle
-     */
-    mimeTypes: string[];
-    /**
-     * Link to documentation
-     */
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    /**
-     * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
-};
-/**
- * TODO: [🦖] Make some system for putting scrapers to separete packages
- * TODO: [🪂] Do it in parallel 11:11
- * TODO: [🦷] Ideally use `as const satisfies Scraper` BUT this combination throws errors
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/typings/src/scrapers/pdf/pdfScraper.d.ts

@@ -1,35 +0,0 @@
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
-/**
- * Scraper for .docx files
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/core`
- */
-export declare const pdfScraper: {
-    /**
-     * Mime types that this scraper can handle
-     */
-    mimeTypes: string[];
-    /**
-     * Link to documentation
-     */
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    /**
-     * Converts the `.pdf` file to `.md` file and returns intermediate source
-     */
-    $convert(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<ScraperIntermediateSource>;
-    /**
-     * Scrapes the `.pdf` file and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
-};
-/**
- * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
- * TODO: [🦖] Make some system for putting scrapers to separete packages
- * TODO: [🪂] Do it in parallel 11:11
- * TODO: [🦷] Ideally use `as const satisfies Converter & Scraper` BUT this combination throws errors
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

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
- */

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

@@ -1,43 +0,0 @@
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
-/**
- * Scraper for .docx files
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/core`
- */
-export declare const websiteScraper: {
-    /**
-     * Mime types that this scraper can handle
-     */
-    mimeTypes: string[];
-    /**
-     * Link to documentation
-     */
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    /**
-     * 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, options: PrepareAndScrapeOptions): Promise<import("destroyable").IDestroyable & {
-        readonly filename: string;
-    } & {
-        markdown: string_markdown;
-    }>;
-    /**
-     * Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): 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: [🦖] Make some system for putting scrapers to separete packages
- * TODO: [🪂] Do it in parallel 11:11
- * TODO: [🦷] Ideally use `as const satisfies Converter & Scraper` BUT this combination throws errors
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts

@@ -1,23 +0,0 @@
-/**
- * @deprecated Use sth from type-fest or move this to type helpers
- */
-type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
-/**
- * Simple options for `execCommand`
- *
- * TODO: !!!!!! Rename - remove I prefix
- */
-export type IExecCommandOptions = string | RequiredAndOptional<IExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
-/**
- * Advanced options for `execCommand`
- *
- * TODO:  !!!!!! Rename - remove I prefix
- */
-export type IExecCommandOptionsAdvanced = {
-    readonly command: string;
-    readonly args: string[];
-    readonly cwd: string;
-    readonly crashOnError: boolean;
-    readonly timeout: number;
-};
-export {};

package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts

@@ -1,10 +0,0 @@
-import type { IExecCommandOptions } from './IExecCommandOptions';
-import type { IExecCommandOptionsAdvanced } from './IExecCommandOptions';
-/**
- * Normalize options for `execCommand` and `execCommands`
- *
- * @private internal utility of `execCommand` and `execCommands`
- */
-export declare function execCommandNormalizeOptions(options: IExecCommandOptions): Pick<IExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
-    humanReadableCommand: string;
-};

package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts

@@ -1,15 +0,0 @@
-import type { string_dirname } from '../../types/typeAliases';
-/**
- * Checks if the directory exists
- *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
- * @private within the repository
- */
-export declare function $isDirectoryExisting(directoryPath: string_dirname): Promise<boolean>;
-/**
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
- * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
- * TODO: [🧠][📂] "directory" vs "folder"
- * TODO: [🖇] What about symlinks?
- */

package/esm/typings/src/utils/files/$isFileExisting.d.ts

@@ -1,14 +0,0 @@
-import type { string_filename } from '../../types/typeAliases';
-/**
- * Checks if the file exists
- *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
- * @private within the repository
- */
-export declare function $isFileExisting(filename: string_filename): Promise<boolean>;
-/**
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
- * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
- * TODO: [🖇] What about symlinks?
- */