@promptbook/node 0.81.0-7 → 0.81.0-9

package/esm/typings/src/_packages/node.index.d.ts

@@ -9,6 +9,7 @@ import { $provideScrapersForNode } from '../scrapers/_common/register/$provideSc
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
+import { wizzard } from '../wizzard/wizzard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createCollectionFromDirectory };
 export { $provideExecutablesForNode };
@@ -20,3 +21,4 @@ export { $provideScrapersForNode };
 export { FileCacheStorage };
 export { $execCommand };
 export { $execCommands };
+export { wizzard };

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

@@ -143,6 +143,7 @@ import type { string_name } from '../types/typeAliases';
 import type { string_parameter_name } from '../types/typeAliases';
 import type { string_parameter_value } from '../types/typeAliases';
 import type { Parameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/typeAliases';
 import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
@@ -407,6 +408,7 @@ export type { string_name };
 export type { string_parameter_name };
 export type { string_parameter_value };
 export type { Parameters };
+export type { InputParameters };
 export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };

package/esm/typings/src/execution/PipelineExecutor.d.ts

@@ -1,6 +1,6 @@
 import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
-import type { Parameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/typeAliases';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
@@ -11,7 +11,7 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    (inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
 };
 /**
  * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
-import type { Parameters } from '../../types/typeAliases';
+import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
@@ -13,7 +13,7 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */
-    readonly inputParameters: Readonly<Parameters>;
+    readonly inputParameters: Readonly<InputParameters>;
     /**
      * @@@
      */

package/esm/typings/src/other/templates/getBookTemplate.d.ts

@@ -1,12 +1,21 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
 import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let templatesPipelineCollection: PipelineCollection | null;
 /**
  * Get template for new book
  *
  * @public exported from `@promptbook/templates`
  */
-export declare function getBookTemplate(formfactorName: string_formfactor_name): Promise<PipelineJson | null>;
+export declare function getBookTemplate(formfactorName: string_formfactor_name): PipelineJson;
 /**
+ * TODO: !!!!!! Test
  * TODO: [🧠] Which is the best place for this function
  * TODO: !!!!!! `book string template notation
  */

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

@@ -1,5 +1,6 @@
 import type { TupleToUnion } from 'type-fest';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
+import type { really_unknown } from '../utils/organization/really_unknown';
 /**
  * Semantic helper
  */
@@ -107,6 +108,13 @@ export type string_parameter_value = string;
  * @see https://ptbk.io/parameters
  */
 export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Parameters to pass to execution of the pipeline
+ *
+ * Note: [🚉] This should be fully serializable as JSON
+ * @see https://ptbk.io/parameters
+ */
+export type InputParameters = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters>;
 /**
  * Semantic helper
  * Unique identifier of reserved parameter

package/esm/typings/src/wizzard/wizzard.d.ts

@@ -0,0 +1,19 @@
+import { Promisable } from 'type-fest';
+import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { InputParameters } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare const wizzard: {
+    /**
+     * @@@!!!!!!
+     */
+    execute(book: string_pipeline_url, inputParameters: InputParameters, onProgress?: ((taskProgress: TaskProgress) => Promisable<void>) | undefined): Promise<PipelineExecutorResult>;
+};
+/**
+ * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.81.0-7",
+    "version": "0.81.0-9",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.81.0-7"
+        "@promptbook/core": "0.81.0-9"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -45,7 +45,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-6';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-8';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2458,6 +2458,81 @@
      *     - [♨] Are tasks prepared
      */
 
+    /**
+     * Format either small or big number
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function numberToString(value) {
+        if (value === 0) {
+            return '0';
+        }
+        else if (Number.isNaN(value)) {
+            return VALUE_STRINGS.nan;
+        }
+        else if (value === Infinity) {
+            return VALUE_STRINGS.infinity;
+        }
+        else if (value === -Infinity) {
+            return VALUE_STRINGS.negativeInfinity;
+        }
+        for (var exponent = 0; exponent < 15; exponent++) {
+            var factor = Math.pow(10, exponent);
+            var valueRounded = Math.round(value * factor) / factor;
+            if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
+                return valueRounded.toFixed(exponent);
+            }
+        }
+        return value.toString();
+    }
+
+    /**
+     * Function `valueToString` will convert the given value to string
+     * This is useful and used in the `templateParameters` function
+     *
+     * Note: This function is not just calling `toString` method
+     *       It's more complex and can handle this conversion specifically for LLM models
+     *       See `VALUE_STRINGS`
+     *
+     * Note: There are 2 similar functions
+     * - `valueToString` converts value to string for LLM models as human-readable string
+     * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function valueToString(value) {
+        try {
+            if (value === '') {
+                return VALUE_STRINGS.empty;
+            }
+            else if (value === null) {
+                return VALUE_STRINGS.null;
+            }
+            else if (value === undefined) {
+                return VALUE_STRINGS.undefined;
+            }
+            else if (typeof value === 'string') {
+                return value;
+            }
+            else if (typeof value === 'number') {
+                return numberToString(value);
+            }
+            else if (value instanceof Date) {
+                return value.toISOString();
+            }
+            else {
+                return JSON.stringify(value);
+            }
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            console.error(error);
+            return VALUE_STRINGS.unserializable;
+        }
+    }
+
     /**
      * Serializes an error into a [🚉] JSON-serializable object
      *
@@ -3167,81 +3242,6 @@
         return [input];
     }
 
-    /**
-     * Format either small or big number
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    function numberToString(value) {
-        if (value === 0) {
-            return '0';
-        }
-        else if (Number.isNaN(value)) {
-            return VALUE_STRINGS.nan;
-        }
-        else if (value === Infinity) {
-            return VALUE_STRINGS.infinity;
-        }
-        else if (value === -Infinity) {
-            return VALUE_STRINGS.negativeInfinity;
-        }
-        for (var exponent = 0; exponent < 15; exponent++) {
-            var factor = Math.pow(10, exponent);
-            var valueRounded = Math.round(value * factor) / factor;
-            if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
-                return valueRounded.toFixed(exponent);
-            }
-        }
-        return value.toString();
-    }
-
-    /**
-     * Function `valueToString` will convert the given value to string
-     * This is useful and used in the `templateParameters` function
-     *
-     * Note: This function is not just calling `toString` method
-     *       It's more complex and can handle this conversion specifically for LLM models
-     *       See `VALUE_STRINGS`
-     *
-     * Note: There are 2 similar functions
-     * - `valueToString` converts value to string for LLM models as human-readable string
-     * - `asSerializable` converts value to string to preserve full information to be able to convert it back
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    function valueToString(value) {
-        try {
-            if (value === '') {
-                return VALUE_STRINGS.empty;
-            }
-            else if (value === null) {
-                return VALUE_STRINGS.null;
-            }
-            else if (value === undefined) {
-                return VALUE_STRINGS.undefined;
-            }
-            else if (typeof value === 'string') {
-                return value;
-            }
-            else if (typeof value === 'number') {
-                return numberToString(value);
-            }
-            else if (value instanceof Date) {
-                return value.toISOString();
-            }
-            else {
-                return JSON.stringify(value);
-            }
-        }
-        catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
-            console.error(error);
-            return VALUE_STRINGS.unserializable;
-        }
-    }
-
     /**
      * Replaces parameters in template with values from parameters object
      *
@@ -4618,7 +4618,10 @@
                         finally { if (e_2) throw e_2.error; }
                         return [7 /*endfinally*/];
                     case 19:
-                        parametersToPass = inputParameters;
+                        parametersToPass = Object.fromEntries(Object.entries(inputParameters).map(function (_a) {
+                            var _b = __read(_a, 2), key = _b[0], value = _b[1];
+                            return [key, valueToString(value)];
+                        }));
                         _g.label = 20;
                     case 20:
                         _g.trys.push([20, 25, , 28]);
@@ -8797,6 +8800,8 @@
         }
         // =============================================================
         // Note: 1️⃣ Parsing of the markdown into object
+        // ==============
+        // Note: 1️⃣◽1️⃣ Remove #!shebang and comments
         if (pipelineString.startsWith('#!')) {
             var _g = __read(pipelineString.split('\n')), shebangLine_1 = _g[0], restLines = _g.slice(1);
             if (!(shebangLine_1 || '').includes('ptbk')) {
@@ -8805,10 +8810,21 @@
             pipelineString = restLines.join('\n');
         }
         pipelineString = removeContentComments(pipelineString);
+        // ==============
+        // Note: 1️⃣◽2️⃣ Process flat pipeline
+        // TODO: !!!!!!
+        // const isMarkdownBeginningWithHeadline =
+        // const isMarkdown
+        // const isMarkdown
+        // const isMarkdown
+        // ==============
+        // Note: 1️⃣◽3️⃣ Parse the markdown
         pipelineString = flattenMarkdown(pipelineString) /* <- Note: [🥞] */;
         pipelineString = pipelineString.replaceAll(/`\{(?<parameterName>[a-z0-9_]+)\}`/gi, '{$<parameterName>}');
         pipelineString = pipelineString.replaceAll(/`->\s+\{(?<parameterName>[a-z0-9_]+)\}`/gi, '-> {$<parameterName>}');
         var _h = __read(splitMarkdownIntoSections(pipelineString).map(parseMarkdownSection)), pipelineHead = _h[0], pipelineSections = _h.slice(1); /* <- Note: [🥞] */
+        // ==============
+        // Note: 1️⃣◽4️⃣ Check markdown structure
         if (pipelineHead === undefined) {
             throw new UnexpectedError(spaceTrim.spaceTrim(function (block) { return "\n                    Pipeline head is not defined\n\n                    ".concat(block(getPipelineIdentification()), "\n\n                    This should never happen, because the pipeline already flattened\n                "); }));
         }
@@ -11183,6 +11199,46 @@
      * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/node`
+     */
+    var wizzard = {
+        /**
+         * @@@!!!!!!
+         */
+        execute: function (book, inputParameters, onProgress) {
+            return __awaiter(this, void 0, void 0, function () {
+                var tools, collection, pipeline, pipelineExecutor, result;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, $provideExecutionToolsForNode()];
+                        case 1:
+                            tools = _a.sent();
+                            return [4 /*yield*/, createCollectionFromDirectory('./books', tools)];
+                        case 2:
+                            collection = _a.sent();
+                            return [4 /*yield*/, collection.getPipelineByUrl(book)];
+                        case 3:
+                            pipeline = _a.sent();
+                            pipelineExecutor = createPipelineExecutor({ pipeline: pipeline, tools: tools });
+                            return [4 /*yield*/, pipelineExecutor(inputParameters, onProgress)];
+                        case 4:
+                            result = _a.sent();
+                            // ▶ Fail if the execution was not successful
+                            assertsExecutionSuccessful(result);
+                            // ▶ Return the result
+                            return [2 /*return*/, result];
+                    }
+                });
+            });
+        },
+    };
+    /**
+     * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+     */
+
     exports.$execCommand = $execCommand;
     exports.$execCommands = $execCommands;
     exports.$provideExecutablesForNode = $provideExecutablesForNode;
@@ -11195,6 +11251,7 @@
     exports.FileCacheStorage = FileCacheStorage;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
     exports.createCollectionFromDirectory = createCollectionFromDirectory;
+    exports.wizzard = wizzard;
 
     Object.defineProperty(exports, '__esModule', { value: true });