@promptbook/utils 0.47.0 → 0.48.0-1

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -27,7 +27,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
-
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,8 +1,11 @@
 import type OpenAI from 'openai';
 import type { PromptResult } from '../../../PromptResult';
 /**
- * !!!
+ * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
  */
 export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+/**
+ * TODO: [🍓] Make better
+ */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -31,5 +31,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private gptCommon;
 }
 /**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/esm/typings/library/SimplePromptbookLibrary.d.ts

@@ -10,7 +10,8 @@ import { PromptbookLibrary } from './PromptbookLibrary';
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
     private library;
-    /**!!!
+    /**
+     * Constructs a promptbook library from promptbooks
      *
      * @param promptbooks !!!
      *

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,5 +1,14 @@
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Constructs Promptbook from given directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
+ *       SO during the construction syntax and logic sources IS NOT validated
+ *
+ * @returns PromptbookLibrary
+ */
 export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -1,7 +1,26 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 import { PromptbookString } from '../../types/PromptbookString';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Constructs Promptbook from async sources
+ * It can be one of the following:
+ * - Promise of array of PromptbookJson or PromptbookString
+ * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
+ *
+ * Note: This is useful as internal tool for other constructor functions like
+ *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       Consider using those functions instead of this one
+ *
+ * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
+ *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
+ *
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PromptbookLibrary
+ *
+ * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +1,15 @@
 import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
 import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /**
- * Constructs Promptbook from any sources
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
  *
+ * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
  * Note: During the construction syntax and logic of all sources are validated
- * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
  *
- * @param promptbookSources contents of .ptbk.md or .ptbk.json files
- * @param settings settings for creating executor functions
+ * @param promptbookSources
  * @returns PromptbookLibrary
  */
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -0,0 +1,13 @@
+import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Constructs Promptbook from remote Promptbase URL
+ *
+ * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
+ *       SO during the construction syntax and logic sources IS NOT validated
+ *
+ * @returns PromptbookLibrary
+ */
+export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+/***
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ */

package/esm/typings/library/constructors/createPromptbookSublibrary.d.ts

@@ -1,6 +1,15 @@
 import type { string_promptbook_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Creates PromptbookLibrary as a subset of another PromptbookLibrary
+ *
+ * Note: You can use any type of library as a parent library - local, remote, etc.
+ * Note: This is just a thin wrapper / proxy around the parent library
+ *
+ * @param promptbookSources
+ * @returns PromptbookLibrary
+ */
 export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -15,5 +15,5 @@ import { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
  */

package/package.json

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

package/umd/index.umd.js

@@ -392,7 +392,7 @@
         return codeBlocks[0];
     }
     /***
-     * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+     * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
      */
 
     /**
@@ -408,7 +408,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.47.0-0';
+    var PROMPTBOOK_VERSION = '0.48.0-0';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -809,6 +809,31 @@
         }
     }
 
+    /**
+     * Removes emojis from a string and fix whitespaces
+     *
+     * @param text with emojis
+     * @returns text without emojis
+     */
+    function removeEmojis(text) {
+        // Replace emojis (and also ZWJ sequence) with hyphens
+        text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
+        text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
+        text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
+        text = text.replace(/\p{Extended_Pictographic}/gu, '');
+        return text;
+    }
+
+    /**
+     * Function normalizes title to name which can be used as identifier
+     */
+    function titleToName(value) {
+        value = removeEmojis(value);
+        value = normalizeToKebabCase(value);
+        // TODO: [🧠] Maybe warn or add some padding to short name which are not good identifiers
+        return value;
+    }
+
     /**
      * Parse promptbook from string format to JSON format
      *
@@ -1049,7 +1074,7 @@
             }
             dependentParameterNames = __spreadArray([], __read(new Set(dependentParameterNames)), false);
             promptbookJson.promptTemplates.push({
-                name: normalizeTo_PascalCase(section.title),
+                name: titleToName(section.title),
                 title: section.title,
                 description: description_1,
                 dependentParameterNames: dependentParameterNames,
@@ -1157,7 +1182,7 @@
             if (!template) {
                 throw new Error("Could not find template for {".concat(parameterName, "}"));
             }
-            return 'template' + normalizeTo_PascalCase(template.title);
+            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(promptbookJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(promptbookJson.promptTemplates
             .flatMap(function (_a) {
@@ -1178,6 +1203,7 @@
             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`
         return promptbookMermaid;
     }
     /**
@@ -1541,11 +1567,10 @@
         var letters = defaultDiacriticsRemovalMap[i].letters;
         // tslint:disable-next-line: prefer-for-of
         for (var j = 0; j < letters.length; j++) {
-            DIACRITIC_VARIANTS_LETTERS[letters[j]] =
-                defaultDiacriticsRemovalMap[i].base;
+            DIACRITIC_VARIANTS_LETTERS[letters[j]] = defaultDiacriticsRemovalMap[i].base;
         }
     }
-    // <- TODO: !!!! Put to maker function
+    // <- TODO: [🍓] Put to maker function to save execution time if not needed
     /*
       @see https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript
        Licensed under the Apache License, Version 2.0 (the "License");
@@ -1762,21 +1787,6 @@
         return value;
     }
 
-    /**
-     * Removes emojis from a string and fix whitespaces
-     *
-     * @param text with emojis
-     * @returns text without emojis
-     */
-    function removeEmojis(text) {
-        // Replace emojis (and also ZWJ sequence) with hyphens
-        text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
-        text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
-        text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
-        text = text.replace(/\p{Extended_Pictographic}/gu, '');
-        return text;
-    }
-
     /**
      * Create a markdown table from a 2D array of strings
      *
@@ -2584,6 +2594,7 @@
     exports.replaceParameters = replaceParameters;
     exports.searchKeywords = searchKeywords;
     exports.splitIntoSentences = splitIntoSentences;
+    exports.titleToName = titleToName;
     exports.trimCodeBlock = trimCodeBlock;
     exports.trimEndOfCodeBlock = trimEndOfCodeBlock;
     exports.unwrapResult = unwrapResult;