@promptbook/utils 0.74.0-0 → 0.74.0-3

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

@@ -1,4 +1,4 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { collectionToJson } from '../collection/collectionToJson';
 import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
 import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
@@ -91,7 +91,7 @@ import type { ExecutionReportStringOptions } from '../types/execution-report/Exe
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { MODEL_VARIANTS } from '../types/ModelVariant';
 import { EXPECTATION_UNITS } from '../types/PipelineJson/Expectations';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { collectionToJson };
 export { createCollectionFromJson };
 export { createCollectionFromPromise };

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

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createDocumentScraper } from '../scrapers/document/createDocumentScraper';
 import { DocumentScraper } from '../scrapers/document/DocumentScraper';
 import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createDocumentScraper };
 export { DocumentScraper };
 export { _DocumentScraperRegistration };

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

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
 import { POSTPROCESSING_FUNCTIONS } from '../scripting/javascript/postprocessing-functions';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { JavascriptEvalExecutionTools };
 export { JavascriptExecutionTools };
 export { POSTPROCESSING_FUNCTIONS };

package/esm/typings/src/_packages/fake-llm.index.d.ts

@@ -1,6 +1,6 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { MockedEchoLlmExecutionTools } from '../llm-providers/mocked/MockedEchoLlmExecutionTools';
 import { MockedFackedLlmExecutionTools } from '../llm-providers/mocked/MockedFackedLlmExecutionTools';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { MockedEchoLlmExecutionTools };
 export { MockedFackedLlmExecutionTools };

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

@@ -1,6 +1,6 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { LangtailExecutionTools } from '../llm-providers/langtail/LangtailExecutionTools';
 import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { LangtailExecutionTools };
 export type { LangtailExecutionToolsOptions };

package/esm/typings/src/_packages/legacy-documents.index.d.ts

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createLegacyDocumentScraper } from '../scrapers/document-legacy/createLegacyDocumentScraper';
 import { LegacyDocumentScraper } from '../scrapers/document-legacy/LegacyDocumentScraper';
 import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createLegacyDocumentScraper };
 export { LegacyDocumentScraper };
 export { _LegacyDocumentScraperRegistration };

package/esm/typings/src/_packages/markdown-utils.index.d.ts

@@ -1,4 +1,4 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { extractBlock } from '../postprocessing/utils/extractBlock';
 import { extractJsonBlock } from '../postprocessing/utils/extractJsonBlock';
 import { createMarkdownScraper } from '../scrapers/markdown/createMarkdownScraper';
@@ -21,7 +21,7 @@ import { parseMarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
 import { splitMarkdownIntoSections } from '../utils/markdown/splitMarkdownIntoSections';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { extractBlock };
 export { extractJsonBlock };
 export { createMarkdownScraper };

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

@@ -1,4 +1,4 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
 import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
 import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
@@ -9,7 +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';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createCollectionFromDirectory };
 export { $provideExecutablesForNode };
 export { $provideExecutionToolsForNode };

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

@@ -1,4 +1,4 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createOpenAiAssistantExecutionTools } from '../llm-providers/openai/createOpenAiAssistantExecutionTools';
 import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAiExecutionTools';
 import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
@@ -8,7 +8,7 @@ import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionToo
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createOpenAiAssistantExecutionTools };
 export { createOpenAiExecutionTools };
 export { OPENAI_MODELS };

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

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createPdfScraper } from '../scrapers/pdf/createPdfScraper';
 import { PdfScraper } from '../scrapers/pdf/PdfScraper';
 import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createPdfScraper };
 export { PdfScraper };
 export { _PdfScraperRegistration };

package/esm/typings/src/_packages/remote-client.index.d.ts

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions';
 import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { RemoteLlmExecutionToolsOptions };
 export type { RemoteServerOptions };
 export { RemoteLlmExecutionTools };

package/esm/typings/src/_packages/remote-server.index.d.ts

@@ -1,6 +1,6 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import { startRemoteServer } from '../llm-providers/remote/startRemoteServer';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { RemoteServerOptions };
 export { startRemoteServer };

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

@@ -1,4 +1,4 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
 import { extractParameterNamesFromTemplate } from '../conversion/utils/extractParameterNamesFromTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
@@ -69,7 +69,7 @@ import { isUrlOnPrivateNetwork } from '../utils/validators/url/isUrlOnPrivateNet
 import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
 import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { renderPromptbookMermaid };
 export { extractParameterNamesFromTemplate };
 export { extractVariables };

package/esm/typings/src/_packages/website-crawler.index.d.ts

@@ -1,8 +1,8 @@
-import { PROMPTBOOK_VERSION } from '../version';
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
-export { PROMPTBOOK_VERSION };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createWebsiteScraper };
 export { _WebsiteScraperRegistration };
 export { WebsiteScraper };

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -7,7 +7,6 @@ import type { Command as Program } from 'commander';
 export declare function initializeMakeCommand(program: Program): void;
 /**
  * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
- * TODO: Maybe remove this command - "about" command should be enough?
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks

package/esm/typings/src/cli/cli-commands/run.d.ts

@@ -0,0 +1,14 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `run` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeRunCommand(program: Program): void;
+/**
+ * TODO: !!!!!! Catch and wrap all errors from CLI
+ * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
+ * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
+ */

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -5,6 +5,7 @@
  */
 export declare function promptbookCli(): Promise<void>;
 /**
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
  * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11

package/esm/typings/src/cli/test/ptbk.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env node
-export {};
+/**
+ * Note: Purpose of this file !!!!!!! vs other place
+ */
+import '../../_packages/cli.index.ts';

package/esm/typings/src/commands/{PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts → BOOK_VERSION/BookVersionCommand.d.ts}

@@ -1,11 +1,11 @@
 import type { string_semantic_version } from '../../types/typeAliases';
 /**
- * Parsed PROMPTBOOK_VERSION command
+ * Parsed BOOK_VERSION command
  *
- * @see ./promptbookVersionCommandParser.ts for more details
+ * @see ./bookVersionCommandParser.ts for more details
  * @private within the commands folder
  */
-export type PromptbookVersionCommand = {
-    readonly type: 'PROMPTBOOK_VERSION';
+export type BookVersionCommand = {
+    readonly type: 'BOOK_VERSION';
     readonly promptbookVersion: string_semantic_version;
 };

package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
+import type { BookVersionCommand } from './BookVersionCommand';
+/**
+ * Parses the BOOK_VERSION command
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+export declare const bookVersionCommandParser: PipelineHeadCommandParser<BookVersionCommand>;

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -169,7 +169,7 @@ export type CommandParserInput = {
     /**
      * @@@
      *
-     * @example 'PROMPTBOOK_VERSION_0_62_0'
+     * @example 'PROMPTBOOK_ENGINE_VERSION_0_62_0'
      * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
      */
     readonly normalized: string_name & string_SCREAMING_CASE;

package/esm/typings/src/commands/index.d.ts

@@ -3,4 +3,4 @@
  *
  * @private internal index of `parseCommand`
  */
-export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./TEMPLATE/TemplateCommand").TemplateCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./TEMPLATE/TemplateCommand").TemplateCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];

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

@@ -1,6 +1,17 @@
 import type { string_semantic_version } from './types/typeAliases';
 /**
- * The version of the Promptbook library
+ * The version of the Book language
+ *
+ * @see https://github.com/webgptorg/book
  */
-export declare const PROMPTBOOK_VERSION: string_promptbook_version;
+export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
+/**
+ * The version of the Promptbook engine
+ *
+ * @see https://github.com/webgptorg/promptbook
+ */
+export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 export type string_promptbook_version = string_semantic_version;
+/**
+ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
+ */ 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.74.0-0",
+    "version": "0.74.0-3",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -10,10 +10,20 @@
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
-     * The version of the Promptbook library
+     * The version of the Book language
+     *
+     * @see https://github.com/webgptorg/book
+     */
+    var BOOK_LANGUAGE_VERSION = '1.0.0';
+    /**
+     * The version of the Promptbook engine
+     *
+     * @see https://github.com/webgptorg/promptbook
+     */
+    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-2';
+    /**
+     * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      */
-    var PROMPTBOOK_VERSION = '0.73.0';
-    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -2388,7 +2398,7 @@
         if ( /* version === '1.0.0' || */version === '2.0.0' || version === '3.0.0') {
             return false;
         }
-        // <- TODO: [main] !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
+        // <- TODO: [main] !!! Check isValidPromptbookVersion against PROMPTBOOK_ENGINE_VERSIONS
         return true;
     }
 
@@ -2493,9 +2503,10 @@
     exports.$isRunningInNode = $isRunningInNode;
     exports.$isRunningInWebWorker = $isRunningInWebWorker;
     exports.$randomSeed = $randomSeed;
+    exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.CountUtils = CountUtils;
     exports.DIACRITIC_VARIANTS_LETTERS = DIACRITIC_VARIANTS_LETTERS;
-    exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
+    exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
     exports.capitalize = capitalize;
     exports.checkSerializableAsJson = checkSerializableAsJson;
     exports.clonePipeline = clonePipeline;