@promptbook/utils 0.48.0 → 0.49.0

package/esm/typings/conversion/promptbookJsonToString.d.ts

@@ -1,8 +1,12 @@
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param promptbookJson Promptbook in JSON format (.ptbk.json)
+ * @returns Promptbook in string format (.ptbk.md)
+ */
 export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
 /**
- * TODO: !!!!! Implement
- * TODO: !!!!! Annotate and warn
- * TODO: !!!!! Test + test together with promptbookStringToJson
+ * TODO: Escape all
  */

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

@@ -0,0 +1,25 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Promptbook to search and replace for parameters
+     * This promptbook is returned as copy with replaced parameters
+     */
+    promptbook: PromptbookJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    newParameterName: string_name;
+};
+/**
+ * Function renameParameter will find all usable parameters for given prompt template
+ * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ *
+ * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+ */
+export declare function renameParameter(options: RenameParameterOptions): PromptbookJson;
+export {};

package/esm/typings/conversion/validation/_importPromptbook.d.ts

@@ -6,6 +6,7 @@ import { PromptbookString } from '../../types/PromptbookString';
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
+ * @param path - The path to the file relative to samples/templates directory
  * @private
  */
 export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;

package/esm/typings/conversion/validation/validatePromptbookJson.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 /**
- * Validates PromptbookJson if it is logically valid.
+ * Validates PromptbookJson if it is logically valid
  *
  * It checks:
  * -   if it has correct parameters dependency
@@ -10,9 +10,10 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * -   if it is meaningful
  *
  * @param promptbook valid or invalid PromptbookJson
+ * @returns the same promptbook if it is logically valid
  * @throws {PromptbookLogicError} on logical error in the promptbook
  */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
+export declare function validatePromptbookJson(promptbook: PromptbookJson): PromptbookJson;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -6,7 +6,7 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson;
 /**
  * Template for prompt to LLM
  */
@@ -50,7 +50,7 @@ interface SimpleTemplateJson extends PromptTemplateJsonCommon {
 /**
  * Template for script execution
  */
-interface ScriptTemplateJson extends PromptTemplateJsonCommon {
+interface ScriptJson extends PromptTemplateJsonCommon {
     readonly executionType: 'SCRIPT';
     /**
      * Language of the script

package/esm/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -2,7 +2,7 @@ import type { string_html } from '../../types/typeAliases';
 /**
  * Prettify the html code
  *
- * @param html raw html code
+ * @param content raw html code
  * @returns formatted html code
  */
-export declare function prettifyMarkdown(html: string_html): string_html;
+export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.48.0",
+    "version": "0.49.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -408,7 +408,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.48.0-1';
+    var PROMPTBOOK_VERSION = '0.48.1-0';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -1135,12 +1135,12 @@
     /**
      * Prettify the html code
      *
-     * @param html raw html code
+     * @param content raw html code
      * @returns formatted html code
      */
-    function prettifyMarkdown(html) {
+    function prettifyMarkdown(content) {
         try {
-            return prettier.format(html, {
+            return prettier.format(content, {
                 parser: 'markdown',
                 plugins: [parserHtml__default["default"]],
                 // TODO: DRY - make some import or auto-copy of .prettierrc
@@ -1158,9 +1158,9 @@
         catch (error) {
             console.error('There was an error with prettifying the markdown, using the original as the fallback', {
                 error: error,
-                html: html,
+                html: content,
             });
-            return html;
+            return content;
         }
     }
 
@@ -1169,7 +1169,8 @@
      *
      * Note: The result is not wrapped in a Markdown code block
      */
-    function renderPromptbookMermaid(promptbookJson) {
+    function renderPromptbookMermaid(promptbookJson, options) {
+        var _a = (options || {}).linkPromptTemplate, linkPromptTemplate = _a === void 0 ? function () { return null; } : _a;
         var parameterNameToTemplateName = function (parameterName) {
             var parameter = promptbookJson.parameters.find(function (parameter) { return parameter.name === parameterName; });
             if (!parameter) {
@@ -1202,8 +1203,18 @@
             var name = _a.name;
             return "".concat(parameterNameToTemplateName(name), "--\"{").concat(name, "}\"-->output");
         })
-            .join('\n')), "\n                  output((Output)):::output\n\n                  classDef input color: grey;\n                  classDef output color: grey;\n\n              end;\n\n        "); });
-        // TODO: !!!!! Allow to put link callback into `renderPromptbookMermaid`
+            .join('\n')), "\n                  output((Output)):::output\n\n                  ").concat(block(promptbookJson.promptTemplates
+            .map(function (promptTemplate) {
+            var link = linkPromptTemplate(promptTemplate);
+            if (link === null) {
+                return '';
+            }
+            var href = link.href, title = link.title;
+            var templateName = parameterNameToTemplateName(promptTemplate.resultingParameterName);
+            return "click ".concat(templateName, " href \"").concat(href, "\" \"").concat(title, "\";");
+        })
+            .filter(function (line) { return line !== ''; })
+            .join('\n')), "\n\n                  classDef input color: grey;\n                  classDef output color: grey;\n\n              end;\n\n        "); });
         return promptbookMermaid;
     }
     /**
@@ -1218,7 +1229,11 @@
         var isGraphAdded = options.isGraphAdded, isPrettifyed = options.isPrettifyed;
         if (isGraphAdded) {
             var promptbookJson = promptbookStringToJson(promptbookString);
-            var promptbookMermaid_1 = renderPromptbookMermaid(promptbookJson);
+            var promptbookMermaid_1 = renderPromptbookMermaid(promptbookJson, {
+                linkPromptTemplate: function (promptTemplate) {
+                    return { href: "#".concat(promptTemplate.name), title: promptTemplate.title };
+                },
+            });
             var promptbookMermaidBlock = spacetrim.spaceTrim(function (block) { return "\n            ```mermaid\n            ".concat(block(promptbookMermaid_1), "\n            ```\n        "); });
             promptbookString = addAutoGeneratedSection(promptbookString, {
                 sectionName: 'Graph',
@@ -1235,6 +1250,76 @@
      * TODO: [🕌] When more than 2 functionalities, split into separate functions
      */
 
+    /**
+     * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+     */
+    var PromptbookLogicError = /** @class */ (function (_super) {
+        __extends(PromptbookLogicError, _super);
+        function PromptbookLogicError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookLogicError';
+            Object.setPrototypeOf(_this, PromptbookLogicError.prototype);
+            return _this;
+        }
+        return PromptbookLogicError;
+    }(Error));
+
+    /**
+     * Function renameParameter will find all usable parameters for given prompt template
+     * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+     *
+     * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+     */
+    function renameParameter(options) {
+        var e_1, _a, e_2, _b;
+        var promptbook = options.promptbook, oldParameterName = options.oldParameterName, newParameterName = options.newParameterName;
+        if (promptbook.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
+            throw new PromptbookLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the promptbook"));
+        }
+        var renamedPromptbook = __assign(__assign({}, promptbook), { parameters: __spreadArray([], __read(promptbook.parameters), false), promptTemplates: __spreadArray([], __read(promptbook.promptTemplates), false) });
+        try {
+            for (var _c = __values(renamedPromptbook.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
+                var parameter = _d.value;
+                if (parameter.name !== oldParameterName) {
+                    continue;
+                }
+                parameter.name = newParameterName;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        try {
+            for (var _e = __values(renamedPromptbook.promptTemplates), _f = _e.next(); !_f.done; _f = _e.next()) {
+                var promptTemplate = _f.value;
+                if (promptTemplate.resultingParameterName === oldParameterName) {
+                    promptTemplate.resultingParameterName = newParameterName;
+                }
+                promptTemplate.dependentParameterNames = promptTemplate.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
+                        ? undefined
+                        : promptTemplate.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        return renamedPromptbook;
+    }
+
     /**
      * This error indicates errors during the execution of the promptbook
      */
@@ -2590,6 +2675,7 @@
     exports.removeEmojis = removeEmojis;
     exports.removeMarkdownFormatting = removeMarkdownFormatting;
     exports.removeQuotes = removeQuotes;
+    exports.renameParameter = renameParameter;
     exports.renderPromptbookMermaid = renderPromptbookMermaid;
     exports.replaceParameters = replaceParameters;
     exports.searchKeywords = searchKeywords;