@promptbook/types 0.72.0-2 → 0.72.0-26

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Run multiple commands in a shell in sequence
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $execCommands({ commands, cwd, crashOnError, }: {
+    readonly commands: string[];
+    readonly cwd: string;
+    readonly crashOnError?: boolean;
+}): Promise<void>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -0,0 +1,19 @@
+/**
+ * @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`
+ */
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
+/**
+ * Advanced options for `execCommand`
+ */
+export type ExecCommandOptionsAdvanced = {
+    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

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

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

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

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -4,7 +4,7 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function splitIntoSentences(text: string): Array<string>;
+export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
 /**
  * Counts number of sentences in the text
  *

package/esm/typings/src/utils/files/extensionToMimeType.d.ts

@@ -0,0 +1,8 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert file extension to mime type
+ *
+ * @private within the repository
+ */
+export declare function extensionToMimeType(value: string_file_extension): string_mime_type;

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

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

package/esm/typings/src/utils/files/getFileExtension.d.ts

@@ -0,0 +1,8 @@
+import type { string_filename } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Get the file extension from a file name
+ *
+ * @private within the repository
+ */
+export declare function getFileExtension(value: string_filename): string_mime_type | null;

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

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

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

@@ -0,0 +1,14 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_dirname, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * 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/isDirectoryExisting.test.d.ts

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

package/esm/typings/src/utils/files/isExecutable.d.ts

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

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

@@ -0,0 +1,13 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filename: string_filename, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */

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

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

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

@@ -0,0 +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
+ *
+ * @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, fs: FilesystemTools): Promise<Array<string_filename>>;
+/**
+ * TODO: [😶] Unite floder listing
+ * 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/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,4 +1,4 @@
-import type { string_file_path } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
@@ -6,4 +6,4 @@ import type { really_unknown } from '../../organization/really_unknown';
  * Note: This does not check if the file exists only if the path is valid
  * @public exported from `@promptbook/utils`
  */
-export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;
+export declare function isValidFilePath(filename: really_unknown): filename is string_filename;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.72.0-2",
+    "version": "0.72.0-26",
     "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-2"
+        "@promptbook/core": "0.72.0-26"
     }
 }

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

@@ -1,40 +0,0 @@
-import type { CsvSettings } from '../../formats/csv/CsvSettings';
-export type CreatePipelineExecutorSettings = {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default MAX_EXECUTION_ATTEMPTS
-     */
-    readonly maxExecutionAttempts: number;
-    /**
-     * Maximum number of tasks running in parallel
-     *
-     * @default MAX_PARALLEL_COUNT
-     */
-    readonly maxParallelCount: number;
-    /**
-     * If true, the preparation logs additional information
-     *
-     * @default false
-     */
-    readonly isVerbose: boolean;
-    /**
-     * 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/knowledge/prepare-knowledge/_common/Scraper.d.ts

@@ -1,37 +0,0 @@
-import type { Promisable } from 'type-fest';
-import type { string_file_path } from '../../../types/typeAliases';
-import type { string_knowledge_source_link } from '../../../types/typeAliases';
-import type { string_markdown } from '../../../types/typeAliases';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_mime_type } from '../../../types/typeAliases';
-import type { string_mime_type_with_wildcard } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
-import type { really_unknown } from '../../../utils/organization/really_unknown';
-/**
- * @@@
- *
- * @private still an internal experimental
- */
-export type Scraper = {
-    readonly description: string_markdown_text;
-    readonly documentationUrl: string_promptbook_documentation_url;
-    readonly examples: Array<string_file_path>;
-    readonly mimeTypes: Array<string_mime_type_with_wildcard>;
-    scrape(source: ScraperSourceOptions): Promisable<string_markdown>;
-};
-/**
- * @@@
- *
- * @private still an internal experimental
- */
-export type ScraperSourceOptions = {
-    readonly source: string_knowledge_source_link;
-    readonly mimeType: string_mime_type;
-    asJson(): Promise<really_unknown>;
-    asText(): Promise<really_unknown>;
-    asBlob(): Promise<really_unknown>;
-};
-/**
- * TODO: [🐝] @@@ Annotate all
- * TODO: [🔼] Export via types
- */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env ts-node
-export {};

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,14 +0,0 @@
-import type { PrepareOptions } from '../../../prepare/PrepareOptions';
-import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
-import type { string_markdown } from '../../../types/typeAliases';
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
-/**
- * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
- * TODO: [🪂] Do it in parallel 11:11
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -1,15 +0,0 @@
-import type { PrepareOptions } from '../../../prepare/PrepareOptions';
-import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
-import type { string_base64 } from '../../../types/typeAliases';
-/**
- * @@@
- *
- * @private still in development [🐝]
- */
-export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
-/**
- * TODO: [🐝][🔼][main] !!! Export via `@promptbook/pdf`
- * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
- *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
- * TODO: [🪂] Do it in parallel
- */

package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts

@@ -1,22 +0,0 @@
-import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-type GetLlmToolsForCliOptions = {
-    /**
-     * @@@
-     *
-     * @default false
-     */
-    isCacheReloaded?: boolean;
-};
-/**
- * Returns LLM tools for CLI
- *
- * @private within the repository - for CLI utils
- */
-export declare function getLlmToolsForCli(options?: GetLlmToolsForCliOptions): LlmExecutionToolsWithTotalUsage;
-export {};
-/**
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- * TODO: [🥃] Allow `ptbk make` without llm tools
- * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
- */

package/esm/typings/src/prepare/PrepareOptions.d.ts

@@ -1,22 +0,0 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
-/**
- * Options for preparation of the pipeline
- */
-export type PrepareOptions = {
-    /**
-     * LLM tools
-     */
-    readonly llmTools: LlmExecutionTools;
-    /**
-     * Maximum number of tasks running in parallel
-     *
-     * @default MAX_PARALLEL_COUNT
-     */
-    readonly maxParallelCount?: number;
-    /**
-     * If true, the preparation logs additional information
-     *
-     * @default false
-     */
-    readonly isVerbose?: boolean;
-};

package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts

@@ -1,10 +0,0 @@
-import type { string_folder_path } from '../../types/typeAliases';
-/**
- * @@@
- */
-export type FilesStorageOptions = {
-    /**
-     * @@@
-     */
-    cacheFolderPath: string_folder_path;
-};

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

@@ -1,15 +0,0 @@
-import type { string_folder_path } 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_folder_path): Promise<boolean>;
-/**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` 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_file_path } 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(filePath: string_file_path): Promise<boolean>;
-/**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` 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?
- */

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

@@ -1,17 +0,0 @@
-import type { string_file_path } from '../../types/typeAliases';
-import type { string_folder_path } 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_folder_path, isRecursive: boolean): Promise<Array<string_file_path>>;
-/**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
- * TODO: [🖇] What about symlinks?
- */