@promptbook/remote-server 0.50.0 → 0.51.0

package/esm/index.es.js

@@ -89,7 +89,7 @@ var PromptbookExecutionError = /** @class */ (function (_super) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.50.0-10';
+var PROMPTBOOK_VERSION = '0.50.0-19';
 
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.

package/esm/typings/_packages/execute-javascript.index.d.ts

@@ -1,3 +1,46 @@
+import spaceTrim from 'spacetrim';
 import { JavascriptEvalExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools';
-export { JavascriptEvalExecutionTools, JavascriptExecutionTools };
+import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
+import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
+import { unwrapResult } from '../utils/unwrapResult';
+declare const POSTPROCESSING_FUNCTIONS: {
+    spaceTrim: typeof spaceTrim;
+    removeQuotes: typeof removeQuotes;
+    unwrapResult: typeof unwrapResult;
+    trimEndOfCodeBlock: typeof trimEndOfCodeBlock;
+    trimCodeBlock: typeof trimCodeBlock;
+    trim: (str: string) => string;
+    reverse: (str: string) => string;
+    removeEmojis: typeof removeEmojis;
+    prettifyMarkdown: typeof prettifyMarkdown;
+    capitalize: typeof capitalize;
+    decapitalize: typeof decapitalize;
+    nameToUriPart: typeof nameToUriPart;
+    nameToUriParts: typeof nameToUriParts;
+    removeDiacritics: typeof removeDiacritics;
+    normalizeWhitespaces: typeof normalizeWhitespaces;
+    normalizeToKebabCase: typeof normalizeToKebabCase;
+    normalizeTo_camelCase: typeof normalizeTo_camelCase;
+    normalizeTo_snake_case: typeof normalizeTo_snake_case;
+    normalizeTo_PascalCase: typeof normalizeTo_PascalCase;
+    parseKeywords: (input: string) => string;
+    normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    extractBlock: typeof extractBlock;
+};
+export { JavascriptEvalExecutionTools, JavascriptExecutionTools, POSTPROCESSING_FUNCTIONS };

package/esm/typings/_packages/openai.index.d.ts

@@ -1,3 +1,4 @@
+import { OPENAI_MODELS } from '../execution/plugins/llm-execution-tools/openai/models';
 import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
 import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
-export { OpenAiExecutionTools, OpenAiExecutionToolsOptions };
+export { OPENAI_MODELS, OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/esm/typings/_packages/types.index.d.ts

@@ -10,7 +10,8 @@ import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
 import type { Prompt } from '../types/Prompt';
-import type { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount, Expectations, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import { EXPECTATION_UNITS } from '../types/PromptbookJson/PromptTemplateJson';
 import type { PromptTemplateParameterJson } from '../types/PromptbookJson/PromptTemplateParameterJson';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
@@ -20,7 +21,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

package/esm/typings/_packages/utils.index.d.ts

@@ -1,6 +1,8 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -16,6 +18,7 @@ import { countPages } from '../utils/expectation-counters/countPages';
 import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
+import { extractParameters } from '../utils/extractParameters';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
@@ -42,12 +45,15 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
@@ -59,7 +65,8 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
-export { renameParameter, renderPromptbookMermaid };
+export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

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

@@ -0,0 +1,13 @@
+import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import { string_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */ 

package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -5,7 +5,8 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {PromptbookSyntaxError} if the script is invalid
- *
- * @private within the promptbookStringToJson
  */
-export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

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

@@ -6,6 +6,3 @@ import type { PromptResult } from '../../../PromptResult';
  * @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/openai/computeUsage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * String value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+type string_openai_price = `$${number}.${number} / ${number}M tokens`;
+/**
+ * Function computeUsage will create price per one token based on the string value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_openai_price): number;
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,25 @@
+import { number_usd } from '../../../../types/typeAliases';
+import type { AvailableModel } from '../../../LlmExecutionTools';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2024-05-20
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ */
+export declare const OPENAI_MODELS: Array<AvailableModel & {
+    pricing?: {
+        prompt: number_usd;
+        output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ */

package/esm/typings/types/ModelRequirements.d.ts

@@ -39,4 +39,5 @@ export type ModelRequirements = {
 /**
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.
+ * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
  */

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

@@ -32,7 +32,7 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
 /**
  * Units of text measurement
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
  */
@@ -133,4 +133,5 @@ export {};
 /**
  * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
  */

package/esm/typings/utils/extractParameters.d.ts

@@ -4,7 +4,5 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
- *
- * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Set<string_name>;

package/esm/typings/utils/sets/difference.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Create difference set of two sets.
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/esm/typings/utils/sets/difference.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/utils/sets/intersection.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/utils/sets/intersection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/utils/sets/union.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/utils/sets/union.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.50.0",
+    "version": "0.51.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -36,7 +36,7 @@
     "dependencies": {
         "colors": "1.4.0",
         "socket.io": "4.7.2",
-        "spacetrim": "0.11.26"
+        "spacetrim": "0.11.25"
     },
     "funding": [
         {
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.50.0"
+        "@promptbook/core": "0.51.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -95,7 +95,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.50.0-10';
+    var PROMPTBOOK_VERSION = '0.50.0-19';
 
     /**
      * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.

package/umd/typings/_packages/execute-javascript.index.d.ts

@@ -1,3 +1,46 @@
+import spaceTrim from 'spacetrim';
 import { JavascriptEvalExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools';
-export { JavascriptEvalExecutionTools, JavascriptExecutionTools };
+import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
+import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
+import { unwrapResult } from '../utils/unwrapResult';
+declare const POSTPROCESSING_FUNCTIONS: {
+    spaceTrim: typeof spaceTrim;
+    removeQuotes: typeof removeQuotes;
+    unwrapResult: typeof unwrapResult;
+    trimEndOfCodeBlock: typeof trimEndOfCodeBlock;
+    trimCodeBlock: typeof trimCodeBlock;
+    trim: (str: string) => string;
+    reverse: (str: string) => string;
+    removeEmojis: typeof removeEmojis;
+    prettifyMarkdown: typeof prettifyMarkdown;
+    capitalize: typeof capitalize;
+    decapitalize: typeof decapitalize;
+    nameToUriPart: typeof nameToUriPart;
+    nameToUriParts: typeof nameToUriParts;
+    removeDiacritics: typeof removeDiacritics;
+    normalizeWhitespaces: typeof normalizeWhitespaces;
+    normalizeToKebabCase: typeof normalizeToKebabCase;
+    normalizeTo_camelCase: typeof normalizeTo_camelCase;
+    normalizeTo_snake_case: typeof normalizeTo_snake_case;
+    normalizeTo_PascalCase: typeof normalizeTo_PascalCase;
+    parseKeywords: (input: string) => string;
+    normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    extractBlock: typeof extractBlock;
+};
+export { JavascriptEvalExecutionTools, JavascriptExecutionTools, POSTPROCESSING_FUNCTIONS };

package/umd/typings/_packages/openai.index.d.ts

@@ -1,3 +1,4 @@
+import { OPENAI_MODELS } from '../execution/plugins/llm-execution-tools/openai/models';
 import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
 import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
-export { OpenAiExecutionTools, OpenAiExecutionToolsOptions };
+export { OPENAI_MODELS, OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/umd/typings/_packages/types.index.d.ts

@@ -10,7 +10,8 @@ import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
 import type { Prompt } from '../types/Prompt';
-import type { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount, Expectations, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import { EXPECTATION_UNITS } from '../types/PromptbookJson/PromptTemplateJson';
 import type { PromptTemplateParameterJson } from '../types/PromptbookJson/PromptTemplateParameterJson';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
@@ -20,7 +21,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

package/umd/typings/_packages/utils.index.d.ts

@@ -1,6 +1,8 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -16,6 +18,7 @@ import { countPages } from '../utils/expectation-counters/countPages';
 import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
+import { extractParameters } from '../utils/extractParameters';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
@@ -42,12 +45,15 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
@@ -59,7 +65,8 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
-export { renameParameter, renderPromptbookMermaid };
+export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts

@@ -0,0 +1,13 @@
+import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import { string_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */ 

package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/conversion/utils/extractVariables.d.ts

@@ -5,7 +5,8 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {PromptbookSyntaxError} if the script is invalid
- *
- * @private within the promptbookStringToJson
  */
-export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

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

@@ -6,6 +6,3 @@ import type { PromptResult } from '../../../PromptResult';
  * @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/umd/typings/execution/plugins/llm-execution-tools/openai/computeUsage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * String value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+type string_openai_price = `$${number}.${number} / ${number}M tokens`;
+/**
+ * Function computeUsage will create price per one token based on the string value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_openai_price): number;
+export {};

package/umd/typings/execution/plugins/llm-execution-tools/openai/computeUsage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/execution/plugins/llm-execution-tools/openai/models.d.ts

@@ -0,0 +1,25 @@
+import { number_usd } from '../../../../types/typeAliases';
+import type { AvailableModel } from '../../../LlmExecutionTools';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2024-05-20
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ */
+export declare const OPENAI_MODELS: Array<AvailableModel & {
+    pricing?: {
+        prompt: number_usd;
+        output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ */

package/umd/typings/types/ModelRequirements.d.ts

@@ -39,4 +39,5 @@ export type ModelRequirements = {
 /**
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.
+ * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
  */

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

@@ -32,7 +32,7 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
 /**
  * Units of text measurement
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
  */
@@ -133,4 +133,5 @@ export {};
 /**
  * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
  */

package/umd/typings/utils/extractParameters.d.ts

@@ -4,7 +4,5 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
- *
- * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Set<string_name>;

package/umd/typings/utils/sets/difference.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Create difference set of two sets.
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/umd/typings/utils/sets/difference.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/sets/intersection.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/utils/sets/intersection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/sets/union.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/utils/sets/union.test.d.ts

@@ -0,0 +1 @@
+export {};