@promptbook/utils 0.67.9 → 0.68.0-1

package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -1,15 +1,26 @@
-import type { ___ } from '../../utils/organization/___';
-import type { LlmTemplateJson } from './LlmTemplateJson';
-import type { PromptDialogJson } from './PromptDialogJson';
-import type { ScriptJson } from './ScriptJson';
-import type { SimpleTemplateJson } from './SimpleTemplateJson';
+import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
- * Describes one prompt template in the promptbook
+ * Template for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+export type PromptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName?: string_name;
+    /**
+     * Requirements for the model
+     * - This is required only for blockType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements?: Partial<ModelRequirements>;
+};
 /**
- * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
- * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ *       @see https://github.com/webgptorg/promptbook/discussions/79
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/{ScriptJson.d.ts → ScriptTemplateJson.d.ts}

@@ -1,13 +1,13 @@
 import type { ScriptLanguage } from '../ScriptLanguage';
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
  * Template for script execution
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
-export type ScriptJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'SCRIPT';
+export type ScriptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'SCRIPT_TEMPLATE';
     /**
      * Language of the script
      * - This is required only for blockType SCRIPT
@@ -16,5 +16,5 @@ export type ScriptJson = PromptTemplateJsonCommon & {
     readonly contentLanguage?: ScriptLanguage;
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -1,13 +1,13 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export type SimpleTemplateJson = PromptTemplateJsonCommon & {
+export type SimpleTemplateJson = TemplateJsonCommon & {
     readonly blockType: 'SIMPLE_TEMPLATE';
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/TemplateJson.d.ts

@@ -0,0 +1,11 @@
+import type { ___or___ } from '../../utils/organization/___or___';
+import type { DialogTemplateJson } from './DialogTemplateJson';
+import type { PromptTemplateJson } from './PromptTemplateJson';
+import type { ScriptTemplateJson } from './ScriptTemplateJson';
+import type { SimpleTemplateJson } from './SimpleTemplateJson';
+/**
+ * Describes one (prompt) template in the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type TemplateJson = PromptTemplateJson | SimpleTemplateJson | ScriptTemplateJson | DialogTemplateJson | ___or___ | ___or___;

package/esm/typings/src/types/PipelineJson/{PromptTemplateJsonCommon.d.ts → TemplateJsonCommon.d.ts}

@@ -1,5 +1,5 @@
 import type { BlockType } from '../../commands/BLOCK/BlockTypes';
-import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
 import type { string_javascript } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
@@ -12,7 +12,7 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all prompt templates
  */
-export interface PromptTemplateJsonCommon {
+export interface TemplateJsonCommon {
     /**
      * Name of the template
      * - It must be unique across the pipeline
@@ -83,14 +83,13 @@ export interface PromptTemplateJsonCommon {
      * @see https://github.com/webgptorg/promptbook/discussions/30
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Name of the parameter that is the result of the prompt template
      */
     readonly resultingParameterName: string_name;
 }
 /**
- * TODO: [🧠][🥜]
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  * TODO: [♈] Probbably move expectations from templates to parameters
  */

package/esm/typings/src/types/Prompt.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
@@ -54,6 +54,8 @@ export type EmbeddingPrompt = CommonPrompt & {
  * Common properties for all prompt results
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompts
  */
 export type CommonPrompt = {
     /**
@@ -89,7 +91,7 @@ export type CommonPrompt = {
      * Note: Expectations are performed after all postprocessing steps
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -10,5 +10,6 @@ export declare function addAutoGeneratedSection(content: string_markdown, option
     readonly sectionContent: string_markdown;
 }): string_markdown;
 /**
+ * TODO: !!!!!! Somw way how to connect this with commands
  * TODO: [🏛] This can be part of markdown builder
  */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -27,7 +27,7 @@ export type CodeBlock = {
  *
  * @param markdown any valid markdown
  * @returns code blocks with language and content
- * @throws {ParsingError} if block is not closed properly
+ * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -3,7 +3,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
- * - When there are multiple or no code blocks the function throws a `ParsingError`
+ * - When there are multiple or no code blocks the function throws a `ParseError`
  *
  * Note: There are multiple simmilar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
@@ -14,7 +14,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  * @param markdown any valid markdown
  * @returns code block with language and content
  * @public exported from `@promptbook/markdown-utils`
- * @throws {ParsingError} if there is not exactly one code block in the markdown
+ * @throws {ParseError} if there is not exactly one code block in the markdown
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***

package/esm/typings/src/utils/organization/___and___.d.ts

@@ -0,0 +1,7 @@
+import type { really_unknown } from './really_unknown';
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___and___ = really_unknown;

package/esm/typings/src/utils/organization/{___.d.ts → ___or___.d.ts}

@@ -3,4 +3,4 @@
  *
  * @private within the repository
  */
-export type ___ = never;
+export type ___or___ = never;

package/esm/typings/src/utils/parseNumber.d.ts

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {ParsingError} if the value is not a number
+ * @throws {ParseError} if the value is not a number
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/serialization/clonePipeline.d.ts

@@ -9,5 +9,5 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.67.9",
+    "version": "0.68.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -12,7 +12,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.67.8';
+    var PROMPTBOOK_VERSION = '0.68.0-0';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -585,7 +585,7 @@
      * @public exported from `@promptbook/utils`
      */
     function renderPromptbookMermaid(pipelineJson, options) {
-        var _a = (options || {}).linkPromptTemplate, linkPromptTemplate = _a === void 0 ? function () { return null; } : _a;
+        var _a = (options || {}).linkTemplate, linkTemplate = _a === void 0 ? function () { return null; } : _a;
         var parameterNameToTemplateName = function (parameterName) {
             var parameter = pipelineJson.parameters.find(function (parameter) { return parameter.name === parameterName; });
             if (!parameter) {
@@ -594,13 +594,13 @@
             if (parameter.isInput) {
                 return 'input';
             }
-            var template = pipelineJson.promptTemplates.find(function (template) { return template.resultingParameterName === parameterName; });
+            var template = pipelineJson.templates.find(function (template) { return template.resultingParameterName === parameterName; });
             if (!template) {
                 throw new Error("Could not find template for {".concat(parameterName, "}"));
             }
             return normalizeTo_camelCase('template-' + titleToName(template.title));
         };
-        var promptbookMermaid = spaceTrim.spaceTrim(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(pipelineJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(pipelineJson.promptTemplates
+        var promptbookMermaid = spaceTrim.spaceTrim(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(pipelineJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(pipelineJson.templates
             .flatMap(function (_a) {
             var title = _a.title, dependentParameterNames = _a.dependentParameterNames, resultingParameterName = _a.resultingParameterName;
             return __spreadArray([
@@ -618,14 +618,14 @@
             var name = _a.name;
             return "".concat(parameterNameToTemplateName(name), "--\"{").concat(name, "}\"-->output");
         })
-            .join('\n')), "\n                  output((Output)):::output\n\n                  ").concat(block(pipelineJson.promptTemplates
-            .map(function (promptTemplate) {
-            var link = linkPromptTemplate(promptTemplate);
+            .join('\n')), "\n                  output((Output)):::output\n\n                  ").concat(block(pipelineJson.templates
+            .map(function (template) {
+            var link = linkTemplate(template);
             if (link === null) {
                 return '';
             }
             var href = link.href, title = link.title;
-            var templateName = parameterNameToTemplateName(promptTemplate.resultingParameterName);
+            var templateName = parameterNameToTemplateName(template.resultingParameterName);
             return "click ".concat(templateName, " href \"").concat(href, "\" \"").concat(title, "\";");
         })
             .filter(function (line) { return line !== ''; })
@@ -670,23 +670,26 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var ParsingError = /** @class */ (function (_super) {
-        __extends(ParsingError, _super);
-        function ParsingError(message) {
+    var ParseError = /** @class */ (function (_super) {
+        __extends(ParseError, _super);
+        function ParseError(message) {
             var _this = _super.call(this, message) || this;
-            _this.name = 'ParsingError';
-            Object.setPrototypeOf(_this, ParsingError.prototype);
+            _this.name = 'ParseError';
+            Object.setPrototypeOf(_this, ParseError.prototype);
             return _this;
         }
-        return ParsingError;
+        return ParseError;
     }(Error));
+    /**
+     * TODO: Maybe split `ParseError` and `ApplyError`
+     */
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
      *
      * @param script from which to extract the variables
      * @returns the list of variable names
-     * @throws {ParsingError} if the script is invalid
+     * @throws {ParseError} if the script is invalid
      * @public exported from `@promptbook/utils`
      */
     function extractVariables(script) {
@@ -722,7 +725,7 @@
             if (!(error instanceof Error)) {
                 throw error;
             }
-            throw new ParsingError(spaceTrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n                "); }));
+            throw new ParseError(spaceTrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n                "); }));
         }
         return variables;
     }
@@ -733,14 +736,14 @@
     /**
      * Parses the prompt template and returns the set of all used parameters
      *
-     * @param promptTemplate the template with used parameters
+     * @param template the template with used parameters
      * @returns the set of parameter names
-     * @throws {ParsingError} if the script is invalid
+     * @throws {ParseError} if the script is invalid
      * @public exported from `@promptbook/utils`
      */
-    function extractParameterNamesFromPromptTemplate(promptTemplate) {
+    function extractParameterNamesFromTemplate(template) {
         var e_1, _a, e_2, _b, e_3, _c;
-        var title = promptTemplate.title, description = promptTemplate.description, blockType = promptTemplate.blockType, content = promptTemplate.content, preparedContent = promptTemplate.preparedContent, jokerParameterNames = promptTemplate.jokerParameterNames;
+        var title = template.title, description = template.description, blockType = template.blockType, content = template.content, preparedContent = template.preparedContent, jokerParameterNames = template.jokerParameterNames;
         var parameterNames = new Set();
         try {
             for (var _d = __values(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameterNames(title)), false), __read(extractParameterNames(description || '')), false), __read(extractParameterNames(content)), false), __read(extractParameterNames(preparedContent || '')), false)), _e = _d.next(); !_e.done; _e = _d.next()) {
@@ -755,7 +758,7 @@
             }
             finally { if (e_1) throw e_1.error; }
         }
-        if (blockType === 'SCRIPT') {
+        if (blockType === 'SCRIPT_TEMPLATE') {
             try {
                 for (var _f = __values(extractVariables(content)), _g = _f.next(); !_g.done; _g = _f.next()) {
                     var parameterName = _g.value;
@@ -820,7 +823,7 @@
         if (pipeline.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
             throw new PipelineLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the pipeline"));
         }
-        var renamedPipeline = __assign(__assign({}, pipeline), { parameters: __spreadArray([], __read(pipeline.parameters), false), promptTemplates: __spreadArray([], __read(pipeline.promptTemplates), false) });
+        var renamedPipeline = __assign(__assign({}, pipeline), { parameters: __spreadArray([], __read(pipeline.parameters), false), templates: __spreadArray([], __read(pipeline.templates), false) });
         try {
             for (var _c = __values(renamedPipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
                 var parameter = _d.value;
@@ -838,20 +841,20 @@
             finally { if (e_1) throw e_1.error; }
         }
         try {
-            for (var _e = __values(renamedPipeline.promptTemplates), _f = _e.next(); !_f.done; _f = _e.next()) {
-                var promptTemplate = _f.value;
-                if (promptTemplate.resultingParameterName === oldParameterName) {
-                    promptTemplate.resultingParameterName = newParameterName;
+            for (var _e = __values(renamedPipeline.templates), _f = _e.next(); !_f.done; _f = _e.next()) {
+                var template = _f.value;
+                if (template.resultingParameterName === oldParameterName) {
+                    template.resultingParameterName = newParameterName;
                 }
-                promptTemplate.dependentParameterNames = promptTemplate.dependentParameterNames.map(function (dependentParameterName) {
+                template.dependentParameterNames = template.dependentParameterNames.map(function (dependentParameterName) {
                     return dependentParameterName === oldParameterName ? newParameterName : dependentParameterName;
                 });
-                promptTemplate.content = promptTemplate.content.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-                promptTemplate.title = promptTemplate.title.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-                promptTemplate.description =
-                    promptTemplate.description === undefined
+                template.content = template.content.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
+                template.title = template.title.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
+                template.description =
+                    template.description === undefined
                         ? undefined
-                        : promptTemplate.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
+                        : template.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }
@@ -1007,7 +1010,7 @@
         LimitReachedError: LimitReachedError,
         NotFoundError: NotFoundError,
         NotYetImplementedError: NotYetImplementedError,
-        ParsingError: ParsingError,
+        ParseError: ParseError,
         PipelineExecutionError: PipelineExecutionError,
         PipelineLogicError: PipelineLogicError,
         PipelineUrlError: PipelineUrlError,
@@ -1530,7 +1533,7 @@
      * Note: it also works only with decimal numbers
      *
      * @returns parsed number
-     * @throws {ParsingError} if the value is not a number
+     * @throws {ParseError} if the value is not a number
      *
      * @public exported from `@promptbook/utils`
      */
@@ -1566,7 +1569,7 @@
             var numerator = parseNumber(numerator_);
             var denominator = parseNumber(denominator_);
             if (denominator === 0) {
-                throw new ParsingError("Unable to parse number from \"".concat(originalValue, "\" because denominator is zero"));
+                throw new ParseError("Unable to parse number from \"".concat(originalValue, "\" because denominator is zero"));
             }
             return numerator / denominator;
         }
@@ -1578,11 +1581,11 @@
             return parseNumber(significand) * Math.pow(10, parseNumber(exponent));
         }
         if (!/^[0-9.]+$/.test(value) || value.split('.').length > 2) {
-            throw new ParsingError("Unable to parse number from \"".concat(originalValue, "\""));
+            throw new ParseError("Unable to parse number from \"".concat(originalValue, "\""));
         }
         var num = parseFloat(value);
         if (isNaN(num)) {
-            throw new ParsingError("Unexpected NaN when parsing number from \"".concat(originalValue, "\""));
+            throw new ParseError("Unexpected NaN when parsing number from \"".concat(originalValue, "\""));
         }
         return num;
     }
@@ -1935,7 +1938,7 @@
      */
     function clonePipeline(pipeline) {
         // Note: Not using spread operator (...) because @@@
-        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, promptbookVersion = pipeline.promptbookVersion, description = pipeline.description, parameters = pipeline.parameters, promptTemplates = pipeline.promptTemplates, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
+        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, promptbookVersion = pipeline.promptbookVersion, description = pipeline.description, parameters = pipeline.parameters, templates = pipeline.templates, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
         return {
             pipelineUrl: pipelineUrl,
             sourceFile: sourceFile,
@@ -1943,7 +1946,7 @@
             promptbookVersion: promptbookVersion,
             description: description,
             parameters: parameters,
-            promptTemplates: promptTemplates,
+            templates: templates,
             knowledgeSources: knowledgeSources,
             knowledgePieces: knowledgePieces,
             personas: personas,
@@ -1951,7 +1954,7 @@
         };
     }
     /**
-     * TODO: [🍙] Make some standart order of json properties
+     * TODO: [🍙] Make some standard order of json properties
      */
 
     /**
@@ -2472,7 +2475,7 @@
     exports.deserializeError = deserializeError;
     exports.difference = difference;
     exports.extractParameterNames = extractParameterNames;
-    exports.extractParameterNamesFromPromptTemplate = extractParameterNamesFromPromptTemplate;
+    exports.extractParameterNamesFromTemplate = extractParameterNamesFromTemplate;
     exports.extractVariables = extractVariables;
     exports.forEachAsync = forEachAsync;
     exports.intersection = intersection;