@promptbook/remote-server 0.75.0-1 → 0.75.0-4

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

@@ -13,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  *
  * @public exported from `@promptbook/core`
  */
-export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
+export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
 /**
  * When the title is not provided, the default title is used
  *
@@ -94,6 +94,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store your books
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOKS_DIRNAME = "./books";
 /**
  * Where to store the cache of executions for promptbook CLI
  *
@@ -101,7 +108,7 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
+export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "./.promptbook/executions-cache";
 /**
  * Where to store the scrape cache
  *
@@ -109,7 +116,7 @@ export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
+export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -193,5 +200,6 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: Extract `constants.ts` from `config.ts`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
@@ -9,7 +9,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `templateParameterJsonToString` , use `stringifyCommand`
+ * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -1,7 +1,7 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 /**
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
@@ -23,7 +23,7 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
- * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [♈] Probbably move expectations from tasks to parameters
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineString } from '../../types/PipelineString';
+import type { PipelineString } from '../../pipeline/PipelineString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
  * Prettyfies Promptbook string and adds Mermaid graph

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -1,14 +1,14 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_href } from '../../types/typeAliases';
 /**
  * Addtional options for rendering Mermaid graph
  */
 export type renderPipelineMermaidOptions = {
     /**
-     * Callback for creating from template graph node
+     * Callback for creating from task graph node
      */
-    linkTemplate?(template: TemplateJson): {
+    linkTask?(task: TaskJson): {
         href: string_href;
         title: string;
     } | null;

package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * Parses the task and returns the set of all used parameters
+ *
+ * @param task the task with used parameters
+ * @returns the set of parameter names
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */

package/esm/typings/src/conversion/utils/renameParameter.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_name } from '../../types/typeAliases';
 type RenameParameterOptions = {
     /**
@@ -16,8 +16,8 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function `renameParameter` will find all usable parameters for given template
- * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
+ * Function `renameParameter` will find all usable parameters for given task
+ * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../../types/PipelineString';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../pipeline/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
  * Import the pipeline.book.md or pipeline.book.json file
@@ -25,5 +25,6 @@ export declare function importPipelineJson(path: `${string}.book.json`): Pipelin
  */
 export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
  * Validates PipelineJson if it is logically valid
  *

package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -13,7 +13,7 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     protected readonly options: CommonToolsOptions;
     constructor(options?: CommonToolsOptions);
     /**
-     * Trigger window.DIALOG TEMPLATE
+     * Trigger window.prompt dialog
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }

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

@@ -27,3 +27,6 @@ export declare const ERRORS: {
     readonly PipelineUrlError: typeof PipelineUrlError;
     readonly UnexpectedError: typeof UnexpectedError;
 };
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

package/esm/typings/src/execution/PipelineExecutorResult.d.ts

@@ -1,8 +1,8 @@
 import { ReadonlyDeep } from 'type-fest';
 import type { ErrorJson } from '../errors/utils/ErrorJson';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../types/typeAliases';
+import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
 import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * @@@

package/esm/typings/src/execution/PromptResultUsage.d.ts

@@ -1,5 +1,5 @@
 import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
 import type { UncertainNumber } from './UncertainNumber';
 /**
  * Usage statistics for one or many prompt results

package/esm/typings/src/execution/ScriptExecutionTools.d.ts

@@ -2,7 +2,7 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { Parameters } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
- * Represents all the tools needed to execute SCRIPT TEMPLATE
+ * Represents all the tools needed to execute `SCRIPT` tasks
  *
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
  */

package/esm/typings/src/execution/createPipelineExecutor/{$OngoingTemplateResult.d.ts → $OngoingTaskResult.d.ts}

@@ -9,7 +9,7 @@ import type { PromptResult } from '../PromptResult';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export type $OngoingTemplateResult = {
+export type $OngoingTaskResult = {
     /**
      * @@@
      */

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

@@ -1,6 +1,6 @@
 import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for `createPipelineExecutor`

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable, ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';

package/esm/typings/src/execution/createPipelineExecutor/{20-executeTemplate.d.ts → 20-executeTask.d.ts}

@@ -1,20 +1,20 @@
 import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
-import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
- * @private internal type of `executeTemplate`
+ * @private internal type of `executeTask`
  */
-type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
+type executeSingleTaskOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
-    readonly currentTemplate: ReadonlyDeep<TemplateJson>;
+    readonly currentTask: ReadonlyDeep<TaskJson>;
     /**
      * @@@
      */
@@ -41,7 +41,7 @@ type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
+export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
 export {};
 /**
  * TODO: [🤹‍♂️]

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,10 +1,10 @@
 import type { ReadonlyDeep, WritableDeep } from 'type-fest';
-import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
@@ -25,7 +25,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
      *
      * Note: [💂] There are two distinct variabiles
      * 1) `maxExecutionAttempts` - the amount of attempts LLM model
-     * 2) `maxAttempts` - the amount of attempts for any template - LLM, SCRIPT, DIALOG, etc.
+     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
      */
     readonly maxAttempts: number;
     /**
@@ -39,7 +39,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
     /**
      * @@@
      */
-    readonly template: ReadonlyDeep<TemplateJson>;
+    readonly task: ReadonlyDeep<TaskJson>;
     /**
      * @@@
      */

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

@@ -1,6 +1,6 @@
 import type { ReadonlyDeep } from 'type-fest';
 import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../../types/typeAliases';
 /**
  * @@@

package/esm/typings/src/execution/createPipelineExecutor/{getContextForTemplate.d.ts → getContextForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/{getExamplesForTemplate.d.ts → getExamplesForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getExamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getExamplesForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

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

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

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 [];
     };
 };