@promptbook/openai 0.70.0-1 → 0.71.0-7

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -11,11 +11,18 @@ import type { string_name } from '../typeAliases';
  */
 export type KnowledgeSourceJson = {
     /**
-     * @@@
+     * Unique identifier of the knowledge source
      */
     readonly name: string_name;
     /**
-     * @@@
+     * Source of one knowledge
+     *
+     * It can be a link, a relative path to file or direct text or combination of those
+     *
+     * For example `"https://pavolhejny.com/"`
+     * For example `"./pavol-hejny-cv.pdf"`
+     * For example `"Pavol Hejný has web https://pavolhejny.com/"`
+     * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
      */
     readonly sourceContent: string_knowledge_source_content;
 };

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -33,6 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -1,5 +1,5 @@
 import type { ModelRequirements } from '../ModelRequirements';
-import type { string_file_path } from '../typeAliases';
+import type { string_filename } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
 import type { string_semantic_version } from '../typeAliases';
@@ -33,7 +33,7 @@ export type PipelineJson = {
     /**
      * Internal helper for tracking the source `.ptbk.md` file of the pipeline
      */
-    readonly sourceFile?: string_file_path;
+    readonly sourceFile?: string_filename;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -42,7 +42,7 @@ export type PipelineJson = {
     /**
      * Version of the .ptbk.json file
      */
-    readonly promptbookVersion: string_semantic_version;
+    readonly promptbookVersion?: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts

@@ -1,3 +1,4 @@
+import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
 import type { TemplateType } from '../../commands/TEMPLATE/TemplateTypes';
 import type { string_javascript } from '../typeAliases';
@@ -42,6 +43,10 @@ export interface TemplateJsonCommon {
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
     readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly foreach?: ForeachJson;
     /**
      * Type of the execution
      * This determines if the template is send to LLM, user or some scripting evaluation

package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { ExecutionReportJson } from './ExecutionReportJson';
 import type { ExecutionReportString } from './ExecutionReportString';
 import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
@@ -6,7 +7,7 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  *
  * @public exported from `@promptbook/core`
  */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
 /**
  * TODO: Add mermaid chart for every report
  * TODO: [🧠] Allow to filter out some parts of the report by options

package/esm/typings/src/types/typeAliases.d.ts

@@ -156,7 +156,7 @@ export type string_knowledge_source_content = string_knowledge_source_link | str
  *
  * @@@ string_knowledge_source vs string_knowledge_source_link
  */
-export type string_knowledge_source_link = string_url | string_file_path;
+export type string_knowledge_source_link = string_url | string_filename;
 /**
  * Semantic helper
  *
@@ -386,6 +386,7 @@ export type string_emails = string;
  *   - `isValidUuid  to check validity
  *
  * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ * TODO: [🥬] Make some system for hashes and ids of promptbook
  */
 export type string_uuid = string & {
     readonly _type: 'uuid';
@@ -423,37 +424,33 @@ export type string_file_extension = string;
  *
  * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_file_absolute_path = string;
+export type string_absolute_filename = string;
 /**
  * Semantic helper
  *
  * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_file_relative_path = string;
+export type string_relative_filename = string;
 /**
  * Semantic helper
  */
-export type string_file_path = string_file_absolute_path | string_file_relative_path;
+export type string_filename = string_absolute_filename | string_relative_filename;
 /**
  * Semantic helper
  *
  * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_folder_absolute_path = string;
+export type string_absolute_dirname = string;
 /**
  * Semantic helper
  *
  * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_folder_relative_path = string;
+export type string_relative_dirname = string;
 /**
  * Semantic helper
  */
-export type string_folder_path = string_file_absolute_path | string_file_relative_path;
-/**
- * Semantic helper
- */
-export type string_filename = string;
+export type string_dirname = string_absolute_dirname | string_relative_dirname;
 /**
  * Semantic helper
  *
@@ -592,7 +589,7 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: !!! Change "For example" to @example
+ * TODO: [main] !!! Change "For example" to @example
  * TODO: !! Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  */

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

@@ -0,0 +1,14 @@
+import type { IExecCommandOptions } from './IExecCommandOptions';
+/**
+ * Run one command in a shell
+ *
+ * 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 $execCommand(options: IExecCommandOptions): Promise<string>;
+/**
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ */

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: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ */

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

@@ -1,4 +1,4 @@
-import type { string_folder_path } from '../../types/typeAliases';
+import type { string_dirname } from '../../types/typeAliases';
 /**
  * Checks if the directory exists
  *
@@ -6,9 +6,9 @@ import type { string_folder_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function $isDirectoryExisting(directoryPath: string_folder_path): Promise<boolean>;
+export declare function $isDirectoryExisting(directoryPath: string_dirname): Promise<boolean>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * 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,4 +1,4 @@
-import type { string_file_path } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
 /**
  * Checks if the file exists
  *
@@ -6,9 +6,9 @@ import type { string_file_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function $isFileExisting(filePath: string_file_path): Promise<boolean>;
+export declare function $isFileExisting(filename: string_filename): Promise<boolean>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * 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?
  */

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

@@ -1,5 +1,5 @@
-import type { string_file_path } from '../../types/typeAliases';
-import type { string_folder_path } from '../../types/typeAliases';
+import type { string_dirname } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
@@ -10,8 +10,8 @@ import type { string_folder_path } from '../../types/typeAliases';
  * @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>>;
+export declare function $listAllFiles(path: string_dirname, isRecursive: boolean): Promise<Array<string_filename>>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
  * TODO: [🖇] What about symlinks?
  */

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/getFileExtension.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/serialization/checkSerializableAsJson.d.ts

@@ -22,6 +22,6 @@ import type { string_name } from '../../types/typeAliases';
 export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -19,6 +19,6 @@
  */
 export declare function isSerializableAsJson(value: unknown): boolean;
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

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/openai",
-    "version": "0.70.0-1",
+    "version": "0.71.0-7",
     "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": {
@@ -47,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.70.0-1"
+        "@promptbook/core": "0.71.0-7"
     },
     "dependencies": {
         "colors": "1.4.0",