@promptbook/openai 0.73.0 → 0.74.0-11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +176 -3
  2. package/esm/index.es.js +20 -8
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +2 -2
  5. package/esm/typings/src/_packages/azure-openai.index.d.ts +2 -2
  6. package/esm/typings/src/_packages/browser.index.d.ts +2 -2
  7. package/esm/typings/src/_packages/cli.index.d.ts +2 -2
  8. package/esm/typings/src/_packages/core.index.d.ts +7 -3
  9. package/esm/typings/src/_packages/documents.index.d.ts +2 -2
  10. package/esm/typings/src/_packages/execute-javascript.index.d.ts +2 -2
  11. package/esm/typings/src/_packages/fake-llm.index.d.ts +2 -2
  12. package/esm/typings/src/_packages/langtail.index.d.ts +2 -2
  13. package/esm/typings/src/_packages/legacy-documents.index.d.ts +2 -2
  14. package/esm/typings/src/_packages/markdown-utils.index.d.ts +2 -2
  15. package/esm/typings/src/_packages/node.index.d.ts +2 -2
  16. package/esm/typings/src/_packages/openai.index.d.ts +2 -2
  17. package/esm/typings/src/_packages/pdf.index.d.ts +2 -2
  18. package/esm/typings/src/_packages/remote-client.index.d.ts +2 -2
  19. package/esm/typings/src/_packages/remote-server.index.d.ts +2 -2
  20. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  21. package/esm/typings/src/_packages/website-crawler.index.d.ts +2 -2
  22. package/esm/typings/src/cli/cli-commands/make.d.ts +0 -1
  23. package/esm/typings/src/cli/cli-commands/run.d.ts +14 -0
  24. package/esm/typings/src/cli/promptbookCli.d.ts +1 -0
  25. package/esm/typings/src/cli/test/ptbk.d.ts +5 -2
  26. package/esm/typings/src/commands/{PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts → BOOK_VERSION/BookVersionCommand.d.ts} +4 -4
  27. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  28. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
  29. package/esm/typings/src/commands/index.d.ts +1 -1
  30. package/esm/typings/src/config.d.ts +6 -0
  31. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  32. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +1 -1
  33. package/esm/typings/src/storage/{memory/utils → utils}/PrefixStorage.d.ts +1 -1
  34. package/esm/typings/src/version.d.ts +13 -2
  35. package/package.json +2 -2
  36. package/umd/index.umd.js +21 -8
  37. package/umd/index.umd.js.map +1 -1
  38. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +0 -9
  39. /package/esm/typings/src/commands/{PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts → BOOK_VERSION/bookVersionCommand.test.d.ts} +0 -0
  40. /package/esm/typings/src/storage/{memory → local-storage}/utils/makePromptbookStorageFromWebStorage.d.ts +0 -0
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { _CLI } from '../cli/main';
3
3
  import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
4
4
  import { _AnthropicClaudeRegistration } from '../llm-providers/anthropic-claude/register-constructor';
@@ -18,7 +18,7 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
18
18
  import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
19
19
  import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
20
20
  import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
21
- export { PROMPTBOOK_VERSION };
21
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
22
22
  export { _CLI };
23
23
  export { _AnthropicClaudeMetadataRegistration };
24
24
  export { _AnthropicClaudeRegistration };
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { collectionToJson } from '../collection/collectionToJson';
3
3
  import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
4
4
  import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
@@ -7,6 +7,7 @@ import { createSubcollection } from '../collection/constructors/createSubcollect
7
7
  import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
8
8
  import { TemplateTypes } from '../commands/TEMPLATE/TemplateTypes';
9
9
  import { CLAIM } from '../config';
10
+ import { DEFAULT_TITLE } from '../config';
10
11
  import { MAX_FILENAME_LENGTH } from '../config';
11
12
  import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
12
13
  import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -84,14 +85,15 @@ import { _DocumentScraperMetadataRegistration } from '../scrapers/document/regis
84
85
  import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
85
86
  import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
86
87
  import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
88
+ import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
87
89
  import { MemoryStorage } from '../storage/memory/MemoryStorage';
88
- import { PrefixStorage } from '../storage/memory/utils/PrefixStorage';
90
+ import { PrefixStorage } from '../storage/utils/PrefixStorage';
89
91
  import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
90
92
  import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
91
93
  import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
92
94
  import { MODEL_VARIANTS } from '../types/ModelVariant';
93
95
  import { EXPECTATION_UNITS } from '../types/PipelineJson/Expectations';
94
- export { PROMPTBOOK_VERSION };
96
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
95
97
  export { collectionToJson };
96
98
  export { createCollectionFromJson };
97
99
  export { createCollectionFromPromise };
@@ -100,6 +102,7 @@ export { createSubcollection };
100
102
  export type { TemplateType };
101
103
  export { TemplateTypes };
102
104
  export { CLAIM };
105
+ export { DEFAULT_TITLE };
103
106
  export { MAX_FILENAME_LENGTH };
104
107
  export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
105
108
  export { DEFAULT_MAX_PARALLEL_COUNT };
@@ -177,6 +180,7 @@ export { _DocumentScraperMetadataRegistration };
177
180
  export { _MarkdownScraperMetadataRegistration };
178
181
  export { _PdfScraperMetadataRegistration };
179
182
  export { _WebsiteScraperMetadataRegistration };
183
+ export { BlackholeStorage };
180
184
  export { MemoryStorage };
181
185
  export { PrefixStorage };
182
186
  export { executionReportJsonToString };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createDocumentScraper } from '../scrapers/document/createDocumentScraper';
3
3
  import { DocumentScraper } from '../scrapers/document/DocumentScraper';
4
4
  import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export { createDocumentScraper };
7
7
  export { DocumentScraper };
8
8
  export { _DocumentScraperRegistration };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
3
3
  import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
4
4
  import { POSTPROCESSING_FUNCTIONS } from '../scripting/javascript/postprocessing-functions';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export { JavascriptEvalExecutionTools };
7
7
  export { JavascriptExecutionTools };
8
8
  export { POSTPROCESSING_FUNCTIONS };
@@ -1,6 +1,6 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { MockedEchoLlmExecutionTools } from '../llm-providers/mocked/MockedEchoLlmExecutionTools';
3
3
  import { MockedFackedLlmExecutionTools } from '../llm-providers/mocked/MockedFackedLlmExecutionTools';
4
- export { PROMPTBOOK_VERSION };
4
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
5
5
  export { MockedEchoLlmExecutionTools };
6
6
  export { MockedFackedLlmExecutionTools };
@@ -1,6 +1,6 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { LangtailExecutionTools } from '../llm-providers/langtail/LangtailExecutionTools';
3
3
  import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
4
- export { PROMPTBOOK_VERSION };
4
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
5
5
  export { LangtailExecutionTools };
6
6
  export type { LangtailExecutionToolsOptions };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createLegacyDocumentScraper } from '../scrapers/document-legacy/createLegacyDocumentScraper';
3
3
  import { LegacyDocumentScraper } from '../scrapers/document-legacy/LegacyDocumentScraper';
4
4
  import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export { createLegacyDocumentScraper };
7
7
  export { LegacyDocumentScraper };
8
8
  export { _LegacyDocumentScraperRegistration };
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { extractBlock } from '../postprocessing/utils/extractBlock';
3
3
  import { extractJsonBlock } from '../postprocessing/utils/extractJsonBlock';
4
4
  import { createMarkdownScraper } from '../scrapers/markdown/createMarkdownScraper';
@@ -21,7 +21,7 @@ import { parseMarkdownSection } from '../utils/markdown/parseMarkdownSection';
21
21
  import { removeContentComments } from '../utils/markdown/removeContentComments';
22
22
  import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
23
23
  import { splitMarkdownIntoSections } from '../utils/markdown/splitMarkdownIntoSections';
24
- export { PROMPTBOOK_VERSION };
24
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
25
25
  export { extractBlock };
26
26
  export { extractJsonBlock };
27
27
  export { createMarkdownScraper };
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
3
3
  import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
4
4
  import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
@@ -9,7 +9,7 @@ import { $provideScrapersForNode } from '../scrapers/_common/register/$provideSc
9
9
  import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
10
10
  import { $execCommand } from '../utils/execCommand/$execCommand';
11
11
  import { $execCommands } from '../utils/execCommand/$execCommands';
12
- export { PROMPTBOOK_VERSION };
12
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
13
13
  export { createCollectionFromDirectory };
14
14
  export { $provideExecutablesForNode };
15
15
  export { $provideExecutionToolsForNode };
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createOpenAiAssistantExecutionTools } from '../llm-providers/openai/createOpenAiAssistantExecutionTools';
3
3
  import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAiExecutionTools';
4
4
  import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
@@ -8,7 +8,7 @@ import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionToo
8
8
  import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
9
9
  import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
10
10
  import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
11
- export { PROMPTBOOK_VERSION };
11
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
12
12
  export { createOpenAiAssistantExecutionTools };
13
13
  export { createOpenAiExecutionTools };
14
14
  export { OPENAI_MODELS };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createPdfScraper } from '../scrapers/pdf/createPdfScraper';
3
3
  import { PdfScraper } from '../scrapers/pdf/PdfScraper';
4
4
  import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export { createPdfScraper };
7
7
  export { PdfScraper };
8
8
  export { _PdfScraperRegistration };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions';
3
3
  import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
4
4
  import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export type { RemoteLlmExecutionToolsOptions };
7
7
  export type { RemoteServerOptions };
8
8
  export { RemoteLlmExecutionTools };
@@ -1,6 +1,6 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
3
3
  import { startRemoteServer } from '../llm-providers/remote/startRemoteServer';
4
- export { PROMPTBOOK_VERSION };
4
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
5
5
  export type { RemoteServerOptions };
6
6
  export { startRemoteServer };
@@ -1,4 +1,4 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
3
3
  import { extractParameterNamesFromTemplate } from '../conversion/utils/extractParameterNamesFromTemplate';
4
4
  import { extractVariables } from '../conversion/utils/extractVariables';
@@ -69,7 +69,7 @@ import { isUrlOnPrivateNetwork } from '../utils/validators/url/isUrlOnPrivateNet
69
69
  import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
70
70
  import { isValidUrl } from '../utils/validators/url/isValidUrl';
71
71
  import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
72
- export { PROMPTBOOK_VERSION };
72
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
73
73
  export { renderPromptbookMermaid };
74
74
  export { extractParameterNamesFromTemplate };
75
75
  export { extractVariables };
@@ -1,8 +1,8 @@
1
- import { PROMPTBOOK_VERSION } from '../version';
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
3
3
  import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
4
4
  import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
5
- export { PROMPTBOOK_VERSION };
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
6
  export { createWebsiteScraper };
7
7
  export { _WebsiteScraperRegistration };
8
8
  export { WebsiteScraper };
@@ -7,7 +7,6 @@ import type { Command as Program } from 'commander';
7
7
  export declare function initializeMakeCommand(program: Program): void;
8
8
  /**
9
9
  * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
10
- * TODO: Maybe remove this command - "about" command should be enough?
11
10
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
12
11
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
12
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
@@ -0,0 +1,14 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `run` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeRunCommand(program: Program): void;
8
+ /**
9
+ * TODO: !!!!!! Catch and wrap all errors from CLI
10
+ * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
11
+ * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
12
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
14
+ */
@@ -5,6 +5,7 @@
5
5
  */
6
6
  export declare function promptbookCli(): Promise<void>;
7
7
  /**
8
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
8
9
  * TODO: [🥠] Do not export, its just for CLI script
9
10
  * TODO: [🕌] When more functionalities, rename
10
11
  * Note: 11:11
@@ -1,2 +1,5 @@
1
- #!/usr/bin/env node
2
- export {};
1
+ #!/usr/bin/env ts-node
2
+ /**
3
+ * Note: Purpose of this file !!!!!!! vs other place
4
+ */
5
+ import '../../_packages/cli.index.ts';
@@ -1,11 +1,11 @@
1
1
  import type { string_semantic_version } from '../../types/typeAliases';
2
2
  /**
3
- * Parsed PROMPTBOOK_VERSION command
3
+ * Parsed BOOK_VERSION command
4
4
  *
5
- * @see ./promptbookVersionCommandParser.ts for more details
5
+ * @see ./bookVersionCommandParser.ts for more details
6
6
  * @private within the commands folder
7
7
  */
8
- export type PromptbookVersionCommand = {
9
- readonly type: 'PROMPTBOOK_VERSION';
8
+ export type BookVersionCommand = {
9
+ readonly type: 'BOOK_VERSION';
10
10
  readonly promptbookVersion: string_semantic_version;
11
11
  };
@@ -0,0 +1,9 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { BookVersionCommand } from './BookVersionCommand';
3
+ /**
4
+ * Parses the BOOK_VERSION command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const bookVersionCommandParser: PipelineHeadCommandParser<BookVersionCommand>;
@@ -169,7 +169,7 @@ export type CommandParserInput = {
169
169
  /**
170
170
  * @@@
171
171
  *
172
- * @example 'PROMPTBOOK_VERSION_0_62_0'
172
+ * @example 'PROMPTBOOK_ENGINE_VERSION_0_62_0'
173
173
  * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
174
174
  */
175
175
  readonly normalized: string_name & string_SCREAMING_CASE;
@@ -3,4 +3,4 @@
3
3
  *
4
4
  * @private internal index of `parseCommand`
5
5
  */
6
- 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>];
6
+ 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>];
@@ -14,6 +14,12 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
14
14
  * @public exported from `@promptbook/core`
15
15
  */
16
16
  export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
17
+ /**
18
+ * When the title is not provided, the default title is used
19
+ *
20
+ * @public exported from `@promptbook/core`
21
+ */
22
+ export declare const DEFAULT_TITLE = "Untitled";
17
23
  /**
18
24
  * Warning message for the generated sections and files files
19
25
  *
@@ -0,0 +1,33 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Behaves like a storage but forgets everything you put in it
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export declare class BlackholeStorage<TItem> implements PromptbookStorage<TItem> {
8
+ /**
9
+ * Returns the number of key/value pairs currently present in the list associated with the object.
10
+ */
11
+ get length(): number;
12
+ /**
13
+ * Empties the list associated with the object of all key/value pairs, if there are any.
14
+ */
15
+ clear(): void;
16
+ /**
17
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
18
+ * @param key
19
+ */
20
+ getItem(key: string): null;
21
+ /**
22
+ * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
23
+ */
24
+ key(index: number): null;
25
+ /**
26
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
27
+ */
28
+ setItem(key: string, value: TItem): void;
29
+ /**
30
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
31
+ */
32
+ removeItem(key: string): void;
33
+ }
@@ -1,6 +1,6 @@
1
1
  import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
2
  /**
3
- * Stores
3
+ * Stores data in memory (HEAP)
4
4
  *
5
5
  * @public exported from `@promptbook/core`
6
6
  */
@@ -1,5 +1,5 @@
1
1
  import type { Promisable } from 'type-fest';
2
- import type { PromptbookStorage } from '../../_common/PromptbookStorage';
2
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
3
3
  /**
4
4
  * This class behaves like LocalStorage but separates keys by prefix
5
5
  *
@@ -1,6 +1,17 @@
1
1
  import type { string_semantic_version } from './types/typeAliases';
2
2
  /**
3
- * The version of the Promptbook library
3
+ * The version of the Book language
4
+ *
5
+ * @see https://github.com/webgptorg/book
4
6
  */
5
- export declare const PROMPTBOOK_VERSION: string_promptbook_version;
7
+ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
8
+ /**
9
+ * The version of the Promptbook engine
10
+ *
11
+ * @see https://github.com/webgptorg/promptbook
12
+ */
13
+ export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
6
14
  export type string_promptbook_version = string_semantic_version;
15
+ /**
16
+ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
17
+ */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.73.0",
3
+ "version": "0.74.0-11",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -53,7 +53,7 @@
53
53
  "module": "./esm/index.es.js",
54
54
  "typings": "./esm/typings/src/_packages/openai.index.d.ts",
55
55
  "peerDependencies": {
56
- "@promptbook/core": "0.73.0"
56
+ "@promptbook/core": "0.74.0-11"
57
57
  },
58
58
  "dependencies": {
59
59
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -12,10 +12,20 @@
12
12
 
13
13
  // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
14
14
  /**
15
- * The version of the Promptbook library
15
+ * The version of the Book language
16
+ *
17
+ * @see https://github.com/webgptorg/book
18
+ */
19
+ var BOOK_LANGUAGE_VERSION = '1.0.0';
20
+ /**
21
+ * The version of the Promptbook engine
22
+ *
23
+ * @see https://github.com/webgptorg/promptbook
24
+ */
25
+ var PROMPTBOOK_ENGINE_VERSION = '0.74.0-10';
26
+ /**
27
+ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
16
28
  */
17
- var PROMPTBOOK_VERSION = '0.72.0';
18
- // TODO: [main] !!!! List here all the versions and annotate + put into script
19
29
 
20
30
  /*! *****************************************************************************
21
31
  Copyright (c) Microsoft Corporation.
@@ -626,10 +636,12 @@
626
636
  * @public exported from `@promptbook/utils`
627
637
  */
628
638
  function countPages(text) {
629
- var sentencesPerPage = 5; // Assuming each page has 5 sentences
630
- var sentences = text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
631
- var pageCount = Math.ceil(sentences.length / sentencesPerPage);
632
- return pageCount;
639
+ if (text === '') {
640
+ return 0;
641
+ }
642
+ var pagesByLinesCount = Math.ceil(countLines(text) / 44);
643
+ var pagesByCharactersCount = Math.ceil(countCharacters(text) / 2772);
644
+ return Math.max(pagesByLinesCount, pagesByCharactersCount);
633
645
  }
634
646
 
635
647
  /**
@@ -2163,10 +2175,11 @@
2163
2175
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
2164
2176
  */
2165
2177
 
2178
+ exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
2166
2179
  exports.OPENAI_MODELS = OPENAI_MODELS;
2167
2180
  exports.OpenAiAssistantExecutionTools = OpenAiAssistantExecutionTools;
2168
2181
  exports.OpenAiExecutionTools = OpenAiExecutionTools;
2169
- exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
2182
+ exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
2170
2183
  exports._OpenAiAssistantRegistration = _OpenAiAssistantRegistration;
2171
2184
  exports._OpenAiRegistration = _OpenAiRegistration;
2172
2185
  exports.createOpenAiAssistantExecutionTools = createOpenAiAssistantExecutionTools;