@promptbook/types 0.72.0-8 → 0.72.0

package/esm/typings/src/utils/files/{$listAllFiles.d.ts → listAllFiles.d.ts}

@@ -1,18 +1,17 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { string_dirname } from '../../types/typeAliases';
 import type { string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
  * @private internal function of `createCollectionFromDirectory`
  */
-export declare function $listAllFiles(path: string_dirname, isRecursive: boolean): Promise<Array<string_filename>>;
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**
  * TODO: [😶] Unite floder listing
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🖇] What about symlinks?
  */

package/esm/typings/src/utils/files/listAllFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -30,7 +30,7 @@ export type CodeBlock = {
  * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
 /**
  * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
  */

package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -5,7 +5,7 @@ import type { string_markdown_section } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
 /**
  * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more

package/esm/typings/src/utils/normalization/IKeywords.d.ts

@@ -2,7 +2,7 @@
  * Semantic helper
  *
  * Keyword is string without diacritics in lowercase [a-z1-9]
- * Words are splitted between multiple keywords @see IKeywords
+ * Words are splitted between multiple keywords @see Keywords
  *
  * For example `"keyword"`
  *
@@ -15,7 +15,7 @@ export type string_keyword = string;
  *
  * @public exported from `@promptbook/utils`
  */
-export type IKeywords = Set<string_keyword>;
+export type Keywords = Set<string_keyword>;
 /**
  * TODO: [🌮] Keywords with weight
  */

package/esm/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,5 +1,5 @@
 import type { really_unknown } from '../organization/really_unknown';
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywords(input: really_unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): Keywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from a string
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywordsFromString(input: string): IKeywords;
+export declare function parseKeywordsFromString(input: string): Keywords;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * @@@
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
  * @returns
  * @public exported from `@promptbook/utils`
  */
-export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function TODO_USE(...value: Array<really_any>): void;
+export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
  * Generates random seed
  *
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
  * @public exported from `@promptbook/utils`
  */
 export declare function $randomSeed(): number_seed;

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/union.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -1,11 +1,11 @@
 /**
  * Additional options for `unwrapResult`
  */
-interface UnwrapResultOptions {
+type UnwrapResultOptions = {
     /**
      * If true, the text is trimmed before processing
      */
-    isTrimmed?: boolean;
+    readonly isTrimmed?: boolean;
     /**
      * If true, the introduce sentence is removed
      *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
      *
      * @default true
      */
-    isIntroduceSentenceRemoved?: boolean;
-}
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
 /**
  * Removes quotes and optional introduce text from a string
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.72.0-8",
+    "version": "0.72.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -11,6 +11,7 @@
     "contributors": [
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
+    "todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -49,6 +50,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-8"
+        "@promptbook/core": "0.72.0"
     }
 }

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