@promptbook/remote-server 0.72.0-0 → 0.72.0-1

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

@@ -1,14 +1,17 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { CsvSettings } from './CsvSettings';
 /**
  * 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>;
+export declare const CsvFormatDefinition: FormatDefinition<string, string, CsvSettings, TODO_any>;
 /**
  * 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/csv/CsvSettings.d.ts

@@ -0,0 +1,13 @@
+import type { ParseConfig, UnparseConfig } from 'papaparse';
+/**
+ * @@@
+ */
+export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MANDATORY_CSV_SETTINGS: Readonly<{
+    readonly header: true;
+}>;

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, 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,18 +1,19 @@
+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`
  * 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,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+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, 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`
+ * 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

@@ -1,18 +1,19 @@
+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`
  * 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/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -20,7 +20,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      *
      * @param options which are relevant are directly passed to the OpenAI client
      */
-    constructor(options?: OpenAiAssistantExecutionToolsOptions);
+    constructor(options: OpenAiAssistantExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**

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

@@ -10,5 +10,5 @@ export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions &
     /**
      * Which assistant to use
      */
-    assistantId?: string_token;
+    assistantId: string_token;
 };

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

@@ -8,6 +8,8 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API
@@ -29,6 +31,13 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<OpenAI>;
+    /**
+     * Create (sub)tools for calling OpenAI API Assistants
+     *
+     * @param assistantId Which assistant to use
+     * @returns Tools for calling OpenAI API Assistants with same token
+     */
+    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -0,0 +1,15 @@
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
+import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiAssistantExecutionTools: ((options: OpenAiAssistantExecutionToolsOptions) => OpenAiAssistantExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * 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/openai/register-configuration.d.ts

@@ -7,3 +7,12 @@
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiMetadataRegistration: void;
+/**
+ * @@@ registration1 of default configuration for Open AI
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantMetadataRegistration: void;

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

@@ -7,6 +7,15 @@
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiRegistration: void;
+/**
+ * @@@ registration2
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantRegistration: void;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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/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/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/remote-server",
-    "version": "0.72.0-0",
+    "version": "0.72.0-1",
     "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/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-0"
+        "@promptbook/core": "0.72.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.68.5';
+    var PROMPTBOOK_VERSION = '0.72.0-0';
     // TODO:[main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -361,10 +361,22 @@
         'samples',
         'modelName',
         'currentDate',
+        // <- TODO: !!!!! list here all command names
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ]);
     // <- TODO: [🧜‍♂️]
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/core`
+     */
+    Object.freeze({
+        delimiter: ',',
+        quoteChar: '"',
+        newline: '\n',
+        skipEmptyLines: true,
+    });
     /**
      * @@@
      *
@@ -604,9 +616,10 @@
         });
         Object.defineProperty(MultipleLlmExecutionTools.prototype, "description", {
             get: function () {
-                return this.llmExecutionTools
-                    .map(function (tools, index) { return "".concat(index + 1, ") ").concat(tools.title, " ").concat(tools.description || ''); })
-                    .join('\n');
+                return this.llmExecutionTools.map(function (_a, index) {
+                    var title = _a.title;
+                    return "".concat(index + 1, ") `").concat(title, "`");
+                }).join('\n');
             },
             enumerable: false,
             configurable: true
@@ -804,9 +817,7 @@
                                 throw new PipelineExecutionError("You have not provided any `LlmExecutionTools`");
                             }
                             else {
-                                throw new PipelineExecutionError(spaceTrim__default["default"](function (block) { return "\n                          You have not provided any `LlmExecutionTools` that support model variant \"".concat(prompt.modelRequirements.modelVariant, "\n\n                          Available `LlmExecutionTools`:\n                          ").concat(block(_this.llmExecutionTools
-                                    .map(function (tools) { return "- ".concat(tools.title, " ").concat(tools.description || ''); })
-                                    .join('\n')), "\n\n                    "); }));
+                                throw new PipelineExecutionError(spaceTrim__default["default"](function (block) { return "\n                          You have not provided any `LlmExecutionTools` that support model variant \"".concat(prompt.modelRequirements.modelVariant, "\"\n\n                          Available `LlmExecutionTools`:\n                          ").concat(block(_this.description), "\n\n                    "); }));
                             }
                     }
                 });