@promptbook/types 0.70.0-0 → 0.71.0-0

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO:[main] !!! Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -9,7 +9,7 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
  * TODO: [🏢] !! Check validity of `temperature` in pipeline

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

@@ -6,7 +6,7 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

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

@@ -23,7 +23,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

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 subparameter 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

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

@@ -39,3 +39,6 @@ export type ExecutionReportJson = {
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };
+/**
+ * TODO: !!!!!! FOREACH in report
+ */ 

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

@@ -592,7 +592,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/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/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/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/{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/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/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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.70.0-0",
+    "version": "0.71.0-0",
     "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.70.0-0"
+        "@promptbook/core": "0.71.0-0"
     }
 }

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