@promptbook/cli 0.69.0-1 → 0.69.0-11

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

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeForTemplate`
+ */
+type GetKnowledgeForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
+export {};

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

@@ -0,0 +1,30 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { ReservedParameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getReservedParametersForTemplate`
+ */
+type GetReservedParametersForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -24,4 +24,6 @@ export declare function checkExpectations(expectations: Expectations, value: str
 export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
 /**
  * TODO: [💝] Unite object for expecting amount and format
+ * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * Note: [💝] and [🤠] are interconnected together
  */

package/esm/typings/src/execution/utils/usageToHuman.d.ts

@@ -7,11 +7,10 @@ import type { PromptResultUsage } from '../PromptResultUsage';
  */
 export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
 /**
- * TODO: Use "$1" not "1 USD"
- * TODO: Use markdown formatting like "Cost approximately **$1**"
- * TODO: Report in minutes, seconds, days NOT 0.1 hours
+ * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
+ * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
+ * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
  * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
- * TODO: When negligible usage, report "Negligible" or just don't report it
  * TODO: [🧠] Maybe use "~" instead of "approximately"
  * TODO: [🏛] Maybe make some markdown builder
  */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -1,22 +1,24 @@
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_mime_type } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
+import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
 /**
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
  *
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema> = {
     /**
      * The name of the format used in .ptbk.md files
      *
      * @sample "JSON"
      */
-    readonly name: string_name;
+    readonly formatName: string_name & string_SCREAMING_CASE;
     /**
-     * Aliases for the name
+     * Aliases for the `formatName`
      */
-    readonly aliases?: Array<string_name>;
+    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
     /**
      * The mime type of the format (if any)
      *
@@ -51,17 +53,12 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      */
     heal(value: string, scheme?: TSchema): TValue;
     /**
-     * Parses just the values and removes structural information
-     *
-     * Note: This is useful when you want to combine format expectations with counting words, characters,...
-     *
-     * @param value The value to check, for example "{\"name\": "John Smith"}"
-     * @param schema Optional schema
-     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
+     * @@@
      */
-    extractValues(value: string, schema?: TSchema): Array<string>;
+    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue>>;
 };
 /**
+ * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
  * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
  * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -0,0 +1,30 @@
+import type { Promisable } from 'type-fest';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FormatSubvalueDefinition<TValue extends string> = {
+    /**
+     * The name of the format used in .ptbk.md files
+     *
+     * @sample "CELL"
+     */
+    readonly subvalueName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `subvalueName`
+     */
+    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
+    /**
+     * Maps values
+     *
+     * For example, if you have a JSON object and you want to map all values to uppercase
+     * Or iterate over all CSV cells @@@
+     */
+    mapValues(value: TValue, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
+};
+/**
+ * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
+ * Note: [👩🏾‍🤝‍🧑🏽]
+ */

package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts}

@@ -2,13 +2,14 @@ import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for CSV spreadsheet
  *
- * @private still in development [🏢]
+ * @public exported from `@promptbook/core`
+ *                          <- TODO: [🏢] Export from package `@promptbook/csv`
  */
 export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
 /**
  * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
- * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
+ * TODO: [🍓] In `CsvFormatDefinition` implement `subvalueDefinitions`
  * TODO: [🏢] Allow to expect something inside CSV objects and other formats
  */

package/esm/typings/src/formats/index.d.ts

@@ -3,4 +3,4 @@
  *
  * @private internal index of `...` <- TODO [🏢]
  */
-export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];
+export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, object>, import("./_common/FormatDefinition").FormatDefinition<string, string, object>, import("./_common/FormatDefinition").FormatDefinition<string, string, never>, import("./_common/FormatDefinition").FormatDefinition<string, string, object>];

package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -13,6 +13,6 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
- * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
+ * TODO: [🍓] In `JsonFormatDefinition` implement `subvalueDefinitions`
  * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

package/esm/typings/src/formats/text/TextFormatDefinition.d.ts

@@ -0,0 +1,17 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for any text - this will be always valid
+ *
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TextFormatDefinition: FormatDefinition<string, string, never>;
+/**
+ * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages aviable as subvalues
+ * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `TextFormatDefinition` implement `heal
+ * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
+ */

package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -13,6 +13,6 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
- * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
+ * TODO: [🍓] In `XmlFormatDefinition` implement `subvalueDefinitions`
  * TODO: [🏢] Allow to expect something inside XML and other formats
  */

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/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/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/{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/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/cli",
-    "version": "0.69.0-1",
+    "version": "0.69.0-11",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -50,6 +50,7 @@
         "commander": "12.0.0",
         "glob-promise": "6.0.5",
         "openai": "4.55.9",
+        "papaparse": "5.4.1",
         "prettier": "2.8.1",
         "socket.io-client": "4.7.2",
         "spacetrim": "0.11.39",