@promptbook/core 0.80.0-0 → 0.80.0-1

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

@@ -29,9 +29,9 @@ import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
+import { compilePipeline } from '../conversion/compilePipeline';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
-import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
-import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
+import { precompilePipeline } from '../conversion/precompilePipeline';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
 import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
 import { removePipelineCommand } from '../conversion/utils/removePipelineCommand';
@@ -150,9 +150,9 @@ export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
+export { compilePipeline };
 export { pipelineJsonToString };
-export { pipelineStringToJson };
-export { pipelineStringToJsonSync };
+export { precompilePipeline };
 export { prettifyPipelineString };
 export { extractParameterNamesFromTask };
 export { removePipelineCommand };

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

@@ -46,8 +46,6 @@ import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
 import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
-import type { AsyncHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
-import type { CommonHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
 import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
@@ -310,8 +308,6 @@ export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };
 export type { string_formfactor_name };
-export type { AsyncHighLevelAbstraction };
-export type { CommonHighLevelAbstraction };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
 export type { LlmToolsOptions };

package/esm/typings/src/commands/_common/getParserForCommand.d.ts

@@ -6,6 +6,6 @@ import type { CommandParser } from './types/CommandParser';
  * @returns the parser for the command
  * @throws {UnexpectedError} if the parser is not found
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function getParserForCommand<TCommand extends Command>(command: TCommand): CommandParser<TCommand>;

package/esm/typings/src/commands/_common/parseCommand.d.ts

@@ -7,6 +7,6 @@ import type { CommandUsagePlace } from './types/CommandUsagePlaces';
  * @returns parsed command object
  * @throws {ParseError} if the command is invalid
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/esm/typings/src/commands/_common/stringifyCommand.d.ts

@@ -6,6 +6,6 @@ import type { Command } from './types/Command';
  * @returns stringified command
  * @throws {UnexpectedError} if the command is invalid
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function stringifyCommand(command: Command): string_markdown_text;

package/esm/typings/src/conversion/{pipelineStringToJson.d.ts → compilePipeline.d.ts}

@@ -6,8 +6,8 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * Compile pipeline from string (markdown) format to JSON format
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -20,7 +20,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools

package/esm/typings/src/conversion/{pipelineStringToJsonSync.d.ts → precompilePipeline.d.ts}

@@ -4,8 +4,8 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -16,7 +16,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+export declare function precompilePipeline(pipelineString: PipelineString): PipelineJson;
 /**
  * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
  * TODO: [main] !!!! Warn if used only sync version

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -1,6 +1,6 @@
 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
 /**
- * Used in `pipelineStringToJsonSync`
+ * Used in `precompilePipeline`
  *
  * @private
  */

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * All high-level abstractions
  *
- * @private internal index of `pipelineStringToJsonSync` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
 export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
     type: "SYNC";

package/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -2,6 +2,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Unprepare just strips the preparation data of the pipeline
  *
+ * @deprecated In future version this function will be removed or deprecated
  * @public exported from `@promptbook/core`
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.80.0-0",
+    "version": "0.80.0-1",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.79.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.80.0-0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1516,6 +1516,7 @@
     /**
      * Unprepare just strips the preparation data of the pipeline
      *
+     * @deprecated In future version this function will be removed or deprecated
      * @public exported from `@promptbook/core`
      */
     function unpreparePipeline(pipeline) {
@@ -7714,7 +7715,7 @@
          * Note: `$` is used to indicate that this function mutates given `pipelineJson`
          */
         $applyToPipelineJson: function (command, $pipelineJson) {
-            // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+            // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
         },
         /**
          * Apply the PARAMETER command to the `pipelineJson`
@@ -7722,7 +7723,7 @@
          * Note: `$` is used to indicate that this function mutates given `taskJson`
          */
         $applyToTaskJson: function (command, $taskJson, $pipelineJson) {
-            // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+            // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
         },
         /**
          * Converts the PARAMETER command back to string
@@ -8230,7 +8231,7 @@
      * @returns the parser for the command
      * @throws {UnexpectedError} if the parser is not found
      *
-     * @private within the pipelineStringToJson
+     * @private within the compilePipeline
      */
     function getParserForCommand(command) {
         var commandParser = COMMANDS.find(function (commandParser) { return commandParser.name === command.type; });
@@ -8266,7 +8267,7 @@
      * @returns parsed command object
      * @throws {ParseError} if the command is invalid
      *
-     * @private within the pipelineStringToJson
+     * @private within the compilePipeline
      */
     function parseCommand(raw, usagePlace) {
         if (raw.includes('\n') || raw.includes('\r')) {
@@ -8681,7 +8682,7 @@
     /**
      * All high-level abstractions
      *
-     * @private internal index of `pipelineStringToJsonSync` (= used for sync) and `preparePipeline` (= used for async)
+     * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
      */
     var HIGH_LEVEL_ABSTRACTIONS = [
         ImplicitFormfactorHla,
@@ -8955,8 +8956,8 @@
      * Compile pipeline from string (markdown) format to JSON format synchronously
      *
      * Note: There are 3 similar functions:
-     * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
-     * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+     * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+     * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
      * - `preparePipeline` - just one step in the compilation process
      *
      * Note: This function does not validate logic of the pipeline only the parsing
@@ -8967,7 +8968,7 @@
      * @throws {ParseError} if the promptbook string is not valid
      * @public exported from `@promptbook/core`
      */
-    function pipelineStringToJsonSync(pipelineString) {
+    function precompilePipeline(pipelineString) {
         var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
         var $pipelineJson = {
             title: DEFAULT_TITLE,
@@ -9387,7 +9388,7 @@
         // TODO: [🍙] Maybe do reorder of `$pipelineJson` here
         return exportJson({
             name: 'pipelineJson',
-            message: "Result of `pipelineStringToJsonSync`",
+            message: "Result of `precompilePipeline`",
             order: ORDER_OF_PIPELINE_JSON,
             value: __assign({ formfactorName: 'GENERIC' }, $pipelineJson),
         });
@@ -9408,8 +9409,8 @@
      * Compile pipeline from string (markdown) format to JSON format
      *
      * Note: There are 3 similar functions:
-     * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
-     * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+     * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+     * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
      * - `preparePipeline` - just one step in the compilation process
      *
      * Note: This function does not validate logic of the pipeline only the parsing
@@ -9422,13 +9423,13 @@
      * @throws {ParseError} if the promptbook string is not valid
      * @public exported from `@promptbook/core`
      */
-    function pipelineStringToJson(pipelineString, tools, options) {
+    function compilePipeline(pipelineString, tools, options) {
         return __awaiter(this, void 0, void 0, function () {
             var pipelineJson;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        pipelineJson = pipelineStringToJsonSync(pipelineString);
+                        pipelineJson = precompilePipeline(pipelineString);
                         if (!(tools !== undefined && tools.llm !== undefined)) return [3 /*break*/, 2];
                         return [4 /*yield*/, preparePipeline(pipelineJson, tools, options || {
                                 rootDirname: null,
@@ -9437,7 +9438,7 @@
                         pipelineJson = _a.sent();
                         _a.label = 2;
                     case 2: 
-                    // Note: No need to use `$exportJson` because `pipelineStringToJsonSync` and `preparePipeline` already do that
+                    // Note: No need to use `$exportJson` because `precompilePipeline` and `preparePipeline` already do that
                     return [2 /*return*/, pipelineJson];
                 }
             });
@@ -9554,7 +9555,7 @@
                     case 0:
                         isGraphAdded = options.isGraphAdded, isPrettifyed = options.isPrettifyed;
                         if (!isGraphAdded) return [3 /*break*/, 2];
-                        return [4 /*yield*/, pipelineStringToJson(pipelineString)];
+                        return [4 /*yield*/, compilePipeline(pipelineString)];
                     case 1:
                         pipelineJson = _a.sent();
                         promptbookMermaid_1 = renderPromptbookMermaid(pipelineJson, {
@@ -11217,6 +11218,7 @@
     exports.assertsExecutionSuccessful = assertsExecutionSuccessful;
     exports.cacheLlmTools = cacheLlmTools;
     exports.collectionToJson = collectionToJson;
+    exports.compilePipeline = compilePipeline;
     exports.countTotalUsage = countTotalUsage;
     exports.createCollectionFromJson = createCollectionFromJson;
     exports.createCollectionFromPromise = createCollectionFromPromise;
@@ -11236,8 +11238,7 @@
     exports.limitTotalUsage = limitTotalUsage;
     exports.makeKnowledgeSourceHandler = makeKnowledgeSourceHandler;
     exports.pipelineJsonToString = pipelineJsonToString;
-    exports.pipelineStringToJson = pipelineStringToJson;
-    exports.pipelineStringToJsonSync = pipelineStringToJsonSync;
+    exports.precompilePipeline = precompilePipeline;
     exports.prepareKnowledgePieces = prepareKnowledgePieces;
     exports.preparePersona = preparePersona;
     exports.preparePipeline = preparePipeline;