@promptbook/core 0.31.0-0 → 0.31.0-10

package/esm/typings/types/execution-report/executionReportJsonToString.d.ts

@@ -1,6 +1,10 @@
 import type { ExecutionReportJson } from './ExecutionReportJson';
 import type { ExecutionReportString } from './ExecutionReportString';
+import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
 /**
  * Converts execution report from JSON to string format
  */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson): ExecutionReportString;
+export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+/**
+ * TODO: [🧠] Allow to filter out some parts of the report by options
+ */

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

@@ -404,6 +404,22 @@ export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;
 export type string_pgp_key = string;
+/**
+ * Semantic helper for `Date.toISOString()` result
+ *
+ * @example "2011-10-05T14:48:00.000Z".
+ * @see https://en.wikipedia.org/wiki/ISO_8601
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
+ */
+export type string_date_iso8601 = `${number}-${number}-${number}${string}${number}:${number}:${number}${string}`;
+/**
+ * Semantic helper for US Dollars
+ */
+export type number_usd = number;
+/**
+ * Semantic helper for number of tokens
+ */
+export type number_tokens = number_integer & number_positive_or_zero;
 export type number_positive = number;
 export type number_negative = number;
 export type number_positive_or_zero = number;

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

@@ -0,0 +1,19 @@
+/**
+ * Represents items which are compared to each other
+ */
+export type FromtoItems = Array<{
+    /**
+     * The title of the item
+     */
+    title: string;
+    /**
+     * The start of the item
+     *
+     * This can mean anything, like seconds, milliseconds, dollars, etc.
+     */
+    from: number;
+    /**
+     * The end of the item
+     */
+    to: number;
+}>;

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

@@ -4,5 +4,7 @@ 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>;

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

@@ -0,0 +1,10 @@
+import { string_javascript, string_javascript_name } from '../types/typeAliases';
+/**
+ * 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
+ *
+ * @private within the library
+ */
+export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Format either small or big number
+ *
+ * @private within the library
+ */
+export declare function formatNumber(value: number): string;

package/esm/typings/utils/formatNumber.test.d.ts

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

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

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

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

@@ -0,0 +1,37 @@
+import { string_markdown } from '../../types/typeAliases';
+import { FromtoItems } from '../FromtoItems';
+/**
+ * Options for creating a markdown chart
+ */
+/**
+ * Options for creating a markdown chart.
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @private within the library
+ */
+export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
+export {};

package/esm/typings/utils/markdown/createMarkdownChart.test.d.ts

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

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

@@ -0,0 +1,7 @@
+import { string_markdown, string_markdown_text } from '../../types/typeAliases';
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @private within the library
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/utils/markdown/createMarkdownTable.test.d.ts

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

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

@@ -6,5 +6,7 @@ import { Parameters } from '../types/Parameters';
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
+ *
+ * @private within the library
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.31.0-0",
+    "version": "0.31.0-10",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -156,6 +156,8 @@
      *
      * @param template the template with parameters in {curly} braces
      * @returns the list of parameter names
+     *
+     * @private within the library
      */
     function extractParameters(template) {
         var e_1, _a;
@@ -180,6 +182,53 @@
         return parameterNames;
     }
 
+    /**
+     * 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
+     *
+     * @private within the library
+     */
+    function extractVariables(script) {
+        var variables = [];
+        script = "(()=>{".concat(script, "})()");
+        try {
+            for (var i = 0; i < 100 /* <- TODO: This limit to configuration */; i++)
+                try {
+                    eval(script);
+                }
+                catch (error) {
+                    if (!(error instanceof ReferenceError)) {
+                        throw error;
+                    }
+                    var undefinedName = error.message.split(' ')[0];
+                    /*
+                    Note: Remapping error
+                          From: [ReferenceError: thing is not defined],
+                          To:   [Error: Parameter {thing} is not defined],
+                    */
+                    if (!undefinedName) {
+                        throw error;
+                    }
+                    if (script.includes(undefinedName + '(')) {
+                        script = "const ".concat(undefinedName, " = ()=>'';") + script;
+                    }
+                    else {
+                        variables.push(undefinedName);
+                        script = "const ".concat(undefinedName, " = '';") + script;
+                    }
+                }
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            throw new Error(spaceTrim__default["default"](function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.name), ": ").concat(block(error.message), "\n                "); }));
+        }
+        return variables;
+    }
+
     /**
      * Computes the deepness of the markdown structure.
      *
@@ -643,6 +692,7 @@
                 type: 'EXPECT_FORMAT',
                 format: 'JSON',
             };
+            // [🥤]
         }
         else if (type.startsWith('EXPECT')) {
             try {
@@ -814,7 +864,7 @@
             finally { if (e_1) throw e_1.error; }
         }
         var _loop_1 = function (section) {
-            var e_3, _e, e_4, _f;
+            var e_3, _e, e_4, _f, e_5, _g;
             // TODO: Parse prompt template description (the content out of the codeblock and lists)
             var templateModelRequirements = __assign({}, defaultModelRequirements);
             var listItems_3 = extractAllListItemsFromMarkdown(section.content);
@@ -887,7 +937,7 @@
                 }
                 finally { if (e_3) throw e_3.error; }
             }
-            var _g = extractOneBlockFromMarkdown(section.content), language = _g.language, content = _g.content;
+            var _h = extractOneBlockFromMarkdown(section.content), language = _h.language, content = _h.content;
             if (executionType === 'SCRIPT') {
                 if (!language) {
                     throw new Error('You must specify the language of the script in the prompt template');
@@ -927,18 +977,34 @@
                 postprocessing = undefined;
             }
             try {
-                for (var _h = (e_4 = void 0, __values(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameters(section.title)), false), __read(extractParameters(description_1 || '')), false), __read(extractParameters(content)), false))), _j = _h.next(); !_j.done; _j = _h.next()) {
-                    var parameterName = _j.value;
+                for (var _j = (e_4 = void 0, __values(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameters(section.title)), false), __read(extractParameters(description_1 || '')), false), __read(extractParameters(content)), false))), _k = _j.next(); !_k.done; _k = _j.next()) {
+                    var parameterName = _k.value;
                     dependentParameterNames.push(parameterName);
                 }
             }
             catch (e_4_1) { e_4 = { error: e_4_1 }; }
             finally {
                 try {
-                    if (_j && !_j.done && (_f = _h.return)) _f.call(_h);
+                    if (_k && !_k.done && (_f = _j.return)) _f.call(_j);
                 }
                 finally { if (e_4) throw e_4.error; }
             }
+            if (executionType === 'SCRIPT') {
+                try {
+                    for (var _l = (e_5 = void 0, __values(extractVariables(content))), _m = _l.next(); !_m.done; _m = _l.next()) {
+                        var parameterName = _m.value;
+                        dependentParameterNames.push(parameterName);
+                    }
+                }
+                catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                finally {
+                    try {
+                        if (_m && !_m.done && (_g = _l.return)) _g.call(_l);
+                    }
+                    finally { if (e_5) throw e_5.error; }
+                }
+            }
+            dependentParameterNames = __spreadArray([], __read(new Set(dependentParameterNames)), false);
             ptbJson.promptTemplates.push({
                 name: n12.normalizeTo_PascalCase(section.title),
                 title: section.title,
@@ -1267,6 +1333,8 @@
      * @param template the template with parameters in {curly} braces
      * @param parameters the object with parameters
      * @returns the template with replaced parameters
+     *
+     * @private within the library
      */
     function replaceParameters(template, parameters) {
         var e_1, _a;
@@ -1853,6 +1921,15 @@
      * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
      */
 
+    /**
+     * Get current date in ISO 8601 format
+     *
+     * @private This is internal util of the promptbook
+     */
+    function getCurrentIsoDate() {
+        return new Date().toISOString();
+    }
+
     /**
      * Mocked execution Tools for just echoing the requests for testing purposes.
      */
@@ -1872,6 +1949,15 @@
                     return [2 /*return*/, {
                             content: spaceTrim__default["default"](function (block) { return "\n                    You said:\n                    ".concat(block(prompt.content), "\n                "); }),
                             model: 'mocked-echo',
+                            timing: {
+                                start: getCurrentIsoDate(),
+                                complete: getCurrentIsoDate(),
+                            },
+                            usage: {
+                                price: 0,
+                                inputTokens: 0,
+                                outputTokens: 0,
+                            },
                             rawResponse: {
                                 note: 'This is mocked echo',
                             },
@@ -1892,6 +1978,15 @@
                     return [2 /*return*/, {
                             content: spaceTrim__default["default"](function (block) { return "\n                    ".concat(block(prompt.content), "\n                    And so on...\n                "); }),
                             model: 'mocked-echo',
+                            timing: {
+                                start: getCurrentIsoDate(),
+                                complete: getCurrentIsoDate(),
+                            },
+                            usage: {
+                                price: 0,
+                                inputTokens: 0,
+                                outputTokens: 0,
+                            },
                             rawResponse: {
                                 note: 'This is mocked echo',
                             },