@promptbook/cli 0.69.0-10 → 0.69.0-12

package/esm/typings/src/_packages/core.index.d.ts

@@ -17,6 +17,7 @@ import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
 import { RESERVED_PARAMETER_NAMES } from '../config';
 import { DEFAULT_REMOTE_URL } from '../config';
 import { DEFAULT_REMOTE_URL_PATH } from '../config';
+import { DEFAULT_CSV_SETTINGS } from '../config';
 import { IS_VERBOSE } from '../config';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
@@ -92,6 +93,7 @@ export { PIPELINE_COLLECTION_BASE_FILENAME };
 export { RESERVED_PARAMETER_NAMES };
 export { DEFAULT_REMOTE_URL };
 export { DEFAULT_REMOTE_URL_PATH };
+export { DEFAULT_CSV_SETTINGS };
 export { IS_VERBOSE };
 export { pipelineJsonToString };
 export type { PipelineStringToJsonOptions };

package/esm/typings/src/_packages/types.index.d.ts

@@ -36,6 +36,7 @@ import type { UncertainNumber } from '../execution/UncertainNumber';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
+import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
@@ -224,6 +225,7 @@ import type { string_camelCase } from '../utils/normalization/normalizeTo_camelC
 import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import type { empty_object } from '../utils/organization/empty_object';
 import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
 import type { string_promptbook_version } from '../version';
@@ -265,6 +267,7 @@ export type { UncertainNumber };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
 export type { FormatSubvalueDefinition };
+export type { CsvSettings };
 export type { CallbackInterfaceToolsOptions };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
@@ -453,6 +456,7 @@ export type { string_camelCase };
 export type { string_PascalCase };
 export type { string_SCREAMING_CASE };
 export type { string_snake_case };
+export type { empty_object };
 export type { really_any };
 export type { TODO_any };
 export type { string_promptbook_version };

package/esm/typings/src/config.d.ts

@@ -1,3 +1,4 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
  * Warning message for the generated sections and files files
  *
@@ -137,6 +138,12 @@ export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
  * @@@
  *
@@ -148,13 +155,13 @@ export declare const IS_VERBOSE = false;
  *
  * @private within the repository
  */
-export declare const IS_COST_PREVENTED: boolean;
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

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

@@ -1,3 +1,4 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
 export type CreatePipelineExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
@@ -17,6 +18,12 @@ export type CreatePipelineExecutorSettings = {
      * @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
      *

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

@@ -1,14 +1,17 @@
-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 { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { empty_object } from '../../utils/organization/empty_object';
 import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
 /**
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
  *
+ * @@@ Describe setting vs schema
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema> = {
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
      * The name of the format used in .ptbk.md files
      *
@@ -31,7 +34,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param value The value to check, for example "{\"foo\": true}"
      * @param schema Optional schema to do extra validation
      */
-    isValid(value: string, schema?: TSchema): value is TValue;
+    isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
     /**
      * Check if a first part of a value is valid
      *
@@ -40,7 +43,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param partialValue Partial value to check, for example "{\"foo\": t"
      * @param schema Optional schema to do extra validation
      */
-    canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
+    canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
     /**
      * Heal a value to make it valid if possible
      *
@@ -51,11 +54,11 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param scheme
      * @throws {Error} If the value cannot be healed
      */
-    heal(value: string, scheme?: TSchema): TValue;
+    heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
     /**
      * @@@
      */
-    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue>>;
+    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
 };
 /**
  * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"

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

@@ -1,11 +1,12 @@
 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';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { empty_object } from '../../utils/organization/empty_object';
 /**
  * @@@
  */
-export type FormatSubvalueDefinition<TValue extends string> = {
+export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
     /**
      * The name of the format used in .ptbk.md files
      *
@@ -22,7 +23,7 @@ export type FormatSubvalueDefinition<TValue extends string> = {
      * 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>;
+    mapValues(value: TValue, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
 };
 /**
  * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"

package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts

@@ -1,11 +1,13 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { CsvSettings } from './CsvSettings';
 /**
  * Definition for CSV spreadsheet
  *
  * @public exported from `@promptbook/core`
  *                          <- TODO: [🏢] Export from package `@promptbook/csv`
  */
-export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
+export declare const CsvFormatDefinition: FormatDefinition<string, string, CsvSettings, TODO_any>;
 /**
  * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`

package/esm/typings/src/formats/csv/CsvSettings.d.ts

@@ -0,0 +1,5 @@
+import type { ParseConfig, UnparseConfig } from "papaparse";
+/**
+ * @@@
+ */
+export type CsvSettings = ParseConfig & UnparseConfig;

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

@@ -3,4 +3,4 @@
  *
  * @private internal index of `...` <- TODO [🏢]
  */
-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>];
+export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];

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

@@ -1,14 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for JSON format
  *
  * @private still in development [🏢]
  */
-export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;
+export declare const JsonFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_json
- * TODO: [1] Make type for JSON Schema
+ * TODO: [1] Make type for JSON Settings and Schema
  * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
  * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`

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

@@ -1,3 +1,4 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for any text - this will be always valid
@@ -6,8 +7,9 @@ import type { FormatDefinition } from '../_common/FormatDefinition';
  *
  * @public exported from `@promptbook/core`
  */
-export declare const TextFormatDefinition: FormatDefinition<string, string, never>;
+export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
+ * TODO: [1] Make type for XML Text and Schema
  * 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`

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

@@ -1,14 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for XML format
  *
  * @private still in development [🏢]
  */
-export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;
+export declare const XmlFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_xml
- * TODO: [1] Make type for XML Schema
+ * TODO: [1] Make type for XML Settings and Schema
  * TODO: [🧠] What to use for validating XMLs - XSD,...
  * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/cli",
-    "version": "0.69.0-10",
+    "version": "0.69.0-12",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,