@promptbook/types 0.75.0-1 → 0.75.0-4

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

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

package/esm/typings/src/{types → execution}/execution-report/ExecutionPromptReportJson.d.ts

@@ -1,6 +1,6 @@
 import type { ErrorJson } from '../../errors/utils/ErrorJson';
-import type { PromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../Prompt';
+import type { Prompt } from '../../types/Prompt';
+import type { PromptResult } from '../PromptResult';
 /**
  * Report of single prompt execution
  *

package/esm/typings/src/{types → execution}/execution-report/ExecutionReportJson.d.ts

@@ -1,6 +1,6 @@
-import type { string_markdown_text } from '../typeAliases';
-import type { string_pipeline_url } from '../typeAliases';
-import type { string_semantic_version } from '../typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_semantic_version } from '../../types/typeAliases';
 import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
@@ -35,7 +35,7 @@ export type ExecutionReportJson = {
      */
     readonly description?: string_markdown_text;
     /**
-     * Sequence of templates in order which were executed
+     * Sequence of tasks in order which were executed
      */
     readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
 };

package/esm/typings/src/{types → execution}/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,4 +1,4 @@
-import type { number_percent } from '../typeAliases';
+import type { number_percent } from '../../types/typeAliases';
 /**
  * Options for `executionReportJsonToString`
  *

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

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PipelineJson/Expectations';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -125,3 +125,6 @@ export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").R
         };
     };
 }>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -4,3 +4,6 @@
  * @private internal index of `...` <- TODO [🏢]
  */
 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>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -8,7 +8,7 @@ export declare const BoilerplateFormfactorDefinition: {
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 };

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -1,10 +1,13 @@
-import type { PipelineInterface } from '../../pipeline/pipeline-interface/PipelineInterface';
+import type { PipelineInterface } from '../../pipeline/PipelineInterface/PipelineInterface';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type AbstractFormfactorDefinition = {
     /**
@@ -32,3 +35,6 @@ export type AbstractFormfactorDefinition = {
      */
     readonly pipelineInterface: PipelineInterface;
 };
+/**
+ * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
+ */

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -1,5 +1,8 @@
 import { FORMFACTOR_DEFINITIONS } from '../index';
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type FormfactorDefinition = typeof FORMFACTOR_DEFINITIONS[number];

package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ChatbotFormfactorDefinition: {
+    readonly name: "CHATBOT";
+    readonly aliasNames: readonly ["CHAT"];
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "previousTitle";
+            readonly description: "Previous title of the conversation";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "previousConversationSummary";
+            readonly description: "Previous conversation summary";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "userMessage";
+            readonly description: "User message";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "title";
+            readonly description: "Title of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "conversationSummary";
+            readonly description: "Summary of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "chatbotResponse";
+            readonly description: "Chatbot response";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generator is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GeneratorFormfactorDefinition: {
+    readonly name: "GENERATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+};

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -6,9 +6,9 @@
 export declare const GenericFormfactorDefinition: {
     readonly name: "GENERIC";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 };

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

@@ -6,34 +6,107 @@
 export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly name: "GENERIC";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 }, {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
-        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+        readonly inputParameters: readonly [{
+            readonly name: "previousTitle";
+            readonly description: "Previous title of the conversation"; /**
+             * All available formfactor definitions
+             *
+             * @public exported from `@promptbook/core`
+             */
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "previousConversationSummary";
+            readonly description: "Previous conversation summary";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "userMessage";
+            readonly description: "User message";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "title";
+            readonly description: "Title of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "conversationSummary";
+            readonly description: "Summary of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "chatbotResponse";
+            readonly description: "Chatbot response";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }, {
     readonly name: "TRANSLATOR";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputMessage"];
-        readonly outputParameterNames: readonly ["outputMessage"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be translated";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputMessage";
+            readonly description: "Translated output message";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }, {
     readonly name: "SHEETS";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputSheet"];
-        readonly outputParameterNames: readonly ["outputSheet"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputSheet";
+            readonly description: "Input sheet to be processed as csv";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputSheet";
+            readonly description: "Output sheet as csv";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+}, {
+    readonly name: "EXPERIMENTAL_MATCHER";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+}, {
+    readonly name: "GENERATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 }];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Matcher is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MatcherFormfactorDefinition: {
+    readonly name: "EXPERIMENTAL_MATCHER";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+};

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -6,9 +6,19 @@
 export declare const SheetsFormfactorDefinition: {
     readonly name: "SHEETS";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputSheet"];
-        readonly outputParameterNames: readonly ["outputSheet"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputSheet";
+            readonly description: "Input sheet to be processed as csv";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputSheet";
+            readonly description: "Output sheet as csv";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -6,9 +6,19 @@
 export declare const TranslatorFormfactorDefinition: {
     readonly name: "TRANSLATOR";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputMessage"];
-        readonly outputParameterNames: readonly ["outputMessage"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be translated";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputMessage";
+            readonly description: "Translated output message";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

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

@@ -20,4 +20,5 @@ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
  * 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
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -8,3 +8,6 @@ import type { Registration } from '../../utils/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _AnthropicClaudeMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AnthropicClaudeRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -8,3 +8,6 @@ import type { Registration } from '../../utils/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AzureOpenAiRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PipelineJson/Expectations';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Gets the expectations and creates a fake text that meets the expectations

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

@@ -27,4 +27,5 @@ export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
  * TODO: [🍓] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
  * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -17,3 +17,6 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -19,4 +19,5 @@ export declare const _OpenAiRegistration: Registration;
 export declare const _OpenAiAssistantRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -1,6 +1,6 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
 import type { string_persona_description } from '../types/typeAliases';
 /**
  * Prepares the persona for the pipeline

package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts

@@ -0,0 +1,26 @@
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type PipelineInterface = {
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
+};
+/**
+ * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
+ * TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
+ */

package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/getPipelineInterface.d.ts

@@ -1,8 +1,10 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
 import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineImplementingInterface.d.ts

@@ -1,7 +1,9 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
 import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
  */
 export type IsPipelineImplementingInterfaceOptions = {
     /**
@@ -16,6 +18,8 @@ export type IsPipelineImplementingInterfaceOptions = {
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineInterfacesEqual.d.ts

@@ -2,6 +2,8 @@ import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;