@promptbook/types 0.72.0-0 → 0.72.0-10

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/IExecCommandOptions.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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

@@ -0,0 +1,10 @@
+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/expectation-counters/index.d.ts

@@ -6,3 +6,6 @@ import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
  * @public exported from `@promptbook/utils`
  */
 export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
+/**
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ */

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/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/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/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/organization/{f.d.ts → empty_object.d.ts}

@@ -1,6 +1,10 @@
 /**
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
  * @private within the repository
  */
-export type really_empty_object = Record<string, never>;
+export type empty_object = {};

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

@@ -0,0 +1,12 @@
+/**
+ * Organizational helper to better @@@@
+ *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
+ * Note: In most cases, you should use `empty_object`
+ *
+ * @private within the repository
+ */
+export type just_empty_object = Record<string, never>;

package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts}

@@ -1,5 +1,5 @@
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
  *

package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts

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

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -0,0 +1,27 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+type MakeapAvailableToExpectedParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
+    /**
+     * @@@
+     */
+    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
+};
+/**
+ * Maps available parameters to expected parameters
+ *
+ * The strategy is:
+ * 1) @@@
+ * 2) @@@
+ *
+ * @throws {PipelineExecutionError} @@@
+ * @private within the repository used in `createPipelineExecutor`
+ */
+export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
+export {};

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts

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

package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts}

@@ -1,5 +1,5 @@
-import type { Parameters } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *

package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts

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

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/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -0,0 +1,10 @@
+import type { string_parameter_name } from '../../../types/typeAliases';
+/**
+ * Function `validateParameterName` will @@@
+ *
+ * @param parameterName @@@
+ * @returns @@@
+ * @throws {ParseError} @@@
+ * @private within the repository
+ */
+export declare function validateParameterName(parameterName: string): string_parameter_name;

package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.72.0-0",
+    "version": "0.72.0-10",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -12,21 +12,25 @@
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
     "keywords": [
-        "autogpt",
-        "openai",
-        "gpt-3",
-        "gpt-4",
-        "chatgpt",
         "ai",
+        "llm",
+        "prompt",
+        "template",
+        "language-model",
+        "chatgpt",
+        "autogpt",
         "machine-learning",
         "natural-language-processing",
         "nlp",
-        "prompt",
-        "template",
-        "pipeline",
-        "automation",
-        "text-generation",
-        "language-model"
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "gpt-4o",
+        "gpt-4o-mini",
+        "o1",
+        "o1-mini",
+        "o1-preview",
+        "anthropic"
     ],
     "license": "CC-BY-4.0",
     "bugs": {
@@ -45,6 +49,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-0"
+        "@promptbook/core": "0.72.0-10"
     }
 }

package/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -1,72 +0,0 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { ExecutionTools } from './ExecutionTools';
-import type { PipelineExecutor } from './PipelineExecutor';
-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;
-    /**
-     * 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;
-};
-/**
- * Options for `createPipelineExecutor`
- */
-interface CreatePipelineExecutorOptions {
-    /**
-     * The pipeline to be executed
-     */
-    readonly pipeline: PipelineJson;
-    /**
-     * The execution tools to be used during the execution of the pipeline
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the pipeline executor
-     */
-    readonly settings?: Partial<CreatePipelineExecutorSettings>;
-}
-/**
- * Creates executor function from pipeline and execution tools.
- *
- * @returns The executor function
- * @throws {PipelineLogicError} on logical error in the pipeline
- * @public exported from `@promptbook/core`
- */
-export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
-export {};
-/**
- * TODO:[main] !!! Identify not only pipeline BUT exact template ${block(pipelineIdentification)}
- * TODO: Use isVerbose here (not only pass to `preparePipeline`)
- * TODO: [🧠][🌳] Use here `countTotalUsage` and put preparation and prepared pipiline to report
- * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
- * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🧠] When not meet expectations in DIALOG_TEMPLATE, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
- * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🧠][💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result BUT maybe NOT to preserve pure JSON object
- */

package/esm/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -1,16 +0,0 @@
-import type { FormatDefinition } from '../_common/FormatDefinition';
-/**
- * Definition for list of multiple items
- *
- * Note: list is just a string with multiple lines or multiple items separated by comma
- *
- * @private still in development [🏢]
- */
-export declare const ListFormatDefinition: FormatDefinition<string, string, object>;
-/**
- * TODO: [🍓] In `ListFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `ListFormatDefinition` implement `heal
- * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
- * TODO: [🏢] Allow to expect something inside each item of list and other formats
- */

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