@promptbook/browser 0.74.0-0 → 0.74.0-12
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.
- package/README.md +135 -30
- package/esm/index.es.js +15 -5
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/anthropic-claude.index.d.ts +2 -2
- package/esm/typings/src/_packages/azure-openai.index.d.ts +2 -2
- package/esm/typings/src/_packages/browser.index.d.ts +2 -2
- package/esm/typings/src/_packages/cli.index.d.ts +2 -2
- package/esm/typings/src/_packages/core.index.d.ts +7 -3
- package/esm/typings/src/_packages/documents.index.d.ts +2 -2
- package/esm/typings/src/_packages/execute-javascript.index.d.ts +2 -2
- package/esm/typings/src/_packages/fake-llm.index.d.ts +2 -2
- package/esm/typings/src/_packages/langtail.index.d.ts +2 -2
- package/esm/typings/src/_packages/legacy-documents.index.d.ts +2 -2
- package/esm/typings/src/_packages/markdown-utils.index.d.ts +2 -2
- package/esm/typings/src/_packages/node.index.d.ts +2 -2
- package/esm/typings/src/_packages/openai.index.d.ts +2 -2
- package/esm/typings/src/_packages/pdf.index.d.ts +2 -2
- package/esm/typings/src/_packages/remote-client.index.d.ts +2 -2
- package/esm/typings/src/_packages/remote-server.index.d.ts +2 -2
- package/esm/typings/src/_packages/utils.index.d.ts +2 -2
- package/esm/typings/src/_packages/website-crawler.index.d.ts +2 -2
- package/esm/typings/src/cli/cli-commands/make.d.ts +0 -1
- package/esm/typings/src/cli/cli-commands/run.d.ts +14 -0
- package/esm/typings/src/cli/promptbookCli.d.ts +1 -0
- package/esm/typings/src/cli/test/ptbk.d.ts +5 -2
- package/esm/typings/src/collection/collectionToJson.test.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +1 -1
- package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
- package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
- package/esm/typings/src/commands/index.d.ts +1 -1
- package/esm/typings/src/config.d.ts +6 -0
- package/esm/typings/src/conversion/pipelineJsonToString.d.ts +3 -3
- package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -2
- package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +2 -2
- package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +7 -7
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +1 -1
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +1 -1
- package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
- package/esm/typings/src/storage/memory/MemoryStorage.d.ts +1 -1
- package/esm/typings/src/storage/{memory/utils → utils}/PrefixStorage.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +6 -4
- package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +1 -1
- package/esm/typings/src/types/Prompt.d.ts +1 -1
- package/esm/typings/src/types/typeAliases.d.ts +2 -2
- package/esm/typings/src/version.d.ts +13 -2
- package/package.json +2 -2
- package/umd/index.umd.js +16 -5
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts +0 -11
- package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +0 -9
- /package/esm/typings/src/commands/{PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts → BOOK_VERSION/bookVersionCommand.test.d.ts} +0 -0
- /package/esm/typings/src/storage/{memory → local-storage}/utils/makePromptbookStorageFromWebStorage.d.ts +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
4
|
+
export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
|
|
5
5
|
export type { RemoteServerOptions };
|
|
6
6
|
export { startRemoteServer };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
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 {
|
|
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 {
|
|
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 {
|
|
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.book.md` -> `ptbk ./foo.book.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,6 +1,6 @@
|
|
|
1
1
|
export {};
|
|
2
2
|
/**
|
|
3
|
-
* Note: [🐠] For example here URL https://example.com/pipeline.
|
|
3
|
+
* Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
|
|
4
4
|
* because it is on private network BUT its very hard to debug because
|
|
5
5
|
* there is no error message and false return (the error) happen deep in:
|
|
6
6
|
* `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
|
|
@@ -5,7 +5,7 @@ import type { PipelineCollection } from '../PipelineCollection';
|
|
|
5
5
|
/**
|
|
6
6
|
* Options for `createCollectionFromDirectory` function
|
|
7
7
|
*
|
|
8
|
-
* Note: `rootDirname` is not needed because it is the folder in which `.
|
|
8
|
+
* Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
|
|
9
9
|
* This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
|
|
10
10
|
*/
|
|
11
11
|
type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_semantic_version } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Parsed BOOK_VERSION command
|
|
4
|
+
*
|
|
5
|
+
* @see ./bookVersionCommandParser.ts for more details
|
|
6
|
+
* @private within the commands folder
|
|
7
|
+
*/
|
|
8
|
+
export type BookVersionCommand = {
|
|
9
|
+
readonly type: 'BOOK_VERSION';
|
|
10
|
+
readonly bookVersion: string_semantic_version;
|
|
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>;
|
|
@@ -3,12 +3,12 @@ import type { ForeachCommand } from './ForeachCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the foreach command
|
|
5
5
|
*
|
|
6
|
-
* Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.
|
|
6
|
+
* Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
|
|
7
7
|
*
|
|
8
8
|
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
10
10
|
*/
|
|
11
11
|
export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
|
|
12
12
|
/**
|
|
13
|
-
* TODO: [🍭] Make .
|
|
13
|
+
* TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
|
|
14
14
|
*/
|
|
@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the boilerplate command
|
|
5
5
|
*
|
|
6
|
-
* Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.
|
|
6
|
+
* Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
|
|
7
7
|
*
|
|
8
8
|
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
@@ -169,7 +169,7 @@ export type CommandParserInput = {
|
|
|
169
169
|
/**
|
|
170
170
|
* @@@
|
|
171
171
|
*
|
|
172
|
-
* @example '
|
|
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("./
|
|
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
|
*
|
|
@@ -3,8 +3,8 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
3
3
|
/**
|
|
4
4
|
* Converts promptbook in JSON format to string format
|
|
5
5
|
*
|
|
6
|
-
* @param pipelineJson Promptbook in JSON format (.
|
|
7
|
-
* @returns Promptbook in string format (.
|
|
6
|
+
* @param pipelineJson Promptbook in JSON format (.book.json)
|
|
7
|
+
* @returns Promptbook in string format (.book.md)
|
|
8
8
|
* @public exported from `@promptbook/core`
|
|
9
9
|
*/
|
|
10
10
|
export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
|
|
@@ -13,5 +13,5 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
|
|
|
13
13
|
* TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
|
|
14
14
|
* TODO: [🏛] Maybe make some markdown builder
|
|
15
15
|
* TODO: [🏛] Escape all
|
|
16
|
-
* TODO: [🧠] Should be in generated .
|
|
16
|
+
* TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
|
|
17
17
|
*/
|
|
@@ -13,10 +13,10 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
13
13
|
* Note: This function does not validate logic of the pipeline only the parsing
|
|
14
14
|
* Note: This function acts as compilation process
|
|
15
15
|
*
|
|
16
|
-
* @param pipelineString {Promptbook} in string markdown format (.
|
|
16
|
+
* @param pipelineString {Promptbook} in string markdown format (.book.md)
|
|
17
17
|
* @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
|
|
18
18
|
* @param options - Options and tools for the compilation
|
|
19
|
-
* @returns {Promptbook} compiled in JSON format (.
|
|
19
|
+
* @returns {Promptbook} compiled in JSON format (.book.json)
|
|
20
20
|
* @throws {ParseError} if the promptbook string is not valid
|
|
21
21
|
* @public exported from `@promptbook/core`
|
|
22
22
|
*/
|
|
@@ -11,8 +11,8 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
11
11
|
* Note: This function does not validate logic of the pipeline only the parsing
|
|
12
12
|
* Note: This function acts as compilation process
|
|
13
13
|
*
|
|
14
|
-
* @param pipelineString {Promptbook} in string markdown format (.
|
|
15
|
-
* @returns {Promptbook} compiled in JSON format (.
|
|
14
|
+
* @param pipelineString {Promptbook} in string markdown format (.book.md)
|
|
15
|
+
* @returns {Promptbook} compiled in JSON format (.book.json)
|
|
16
16
|
* @throws {ParseError} if the promptbook string is not valid
|
|
17
17
|
* @public exported from `@promptbook/core`
|
|
18
18
|
*/
|
|
@@ -9,7 +9,7 @@ import type { string_json } from '../../types/typeAliases';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
|
|
11
11
|
/**
|
|
12
|
-
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.
|
|
12
|
+
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
|
|
13
13
|
* TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
|
|
14
14
|
* TODO: [🧠] Maybe more elegant solution than replacing via regex
|
|
15
15
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
|
|
|
2
2
|
import type { PipelineString } from '../../types/PipelineString';
|
|
3
3
|
import type { string_json } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
|
-
* Import the pipeline.
|
|
5
|
+
* Import the pipeline.book.md or pipeline.book.json file
|
|
6
6
|
*
|
|
7
7
|
* Note: Using here custom import to work in jest tests
|
|
8
8
|
* Note: Using sync version is 💩 in the production code, but it's ok here in tests
|
|
@@ -10,20 +10,20 @@ import type { string_json } from '../../types/typeAliases';
|
|
|
10
10
|
* @param path - The path to the file relative to examples/pipelines directory
|
|
11
11
|
* @private internal function of tests
|
|
12
12
|
*/
|
|
13
|
-
export declare function importPipelineWithoutPreparation(path: `${string}.
|
|
14
|
-
export declare function importPipelineWithoutPreparation(path: `${string}.
|
|
13
|
+
export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
|
|
14
|
+
export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
|
|
15
15
|
/**
|
|
16
|
-
* Import the pipeline.
|
|
16
|
+
* Import the pipeline.book.json file as parsed JSON
|
|
17
17
|
*
|
|
18
18
|
* @private internal function of tests
|
|
19
19
|
*/
|
|
20
|
-
export declare function importPipelineJson(path: `${string}.
|
|
20
|
+
export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
|
|
21
21
|
/**
|
|
22
|
-
* Import the pipeline.
|
|
22
|
+
* Import the pipeline.book.json file as string
|
|
23
23
|
*
|
|
24
24
|
* @private internal function of tests
|
|
25
25
|
*/
|
|
26
|
-
export declare function importPipelineJsonAsString(path: `${string}.
|
|
26
|
+
export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
|
|
27
27
|
/**
|
|
28
28
|
* Note: [⚫] Code in this file should never be published in any package
|
|
29
29
|
*/
|
|
@@ -13,7 +13,7 @@ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
|
|
|
13
13
|
*/
|
|
14
14
|
export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
|
|
15
15
|
/**
|
|
16
|
-
* The name of the format used in .
|
|
16
|
+
* The name of the format used in .book.md files
|
|
17
17
|
*
|
|
18
18
|
* @example "JSON"
|
|
19
19
|
*/
|
|
@@ -9,7 +9,7 @@ import type { empty_object } from '../../utils/organization/empty_object';
|
|
|
9
9
|
*/
|
|
10
10
|
export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
|
|
11
11
|
/**
|
|
12
|
-
* The name of the format used in .
|
|
12
|
+
* The name of the format used in .book.md files
|
|
13
13
|
*
|
|
14
14
|
* @example "CELL"
|
|
15
15
|
*/
|
|
@@ -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,5 +1,5 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type { PromptbookStorage } from '
|
|
2
|
+
import type { PromptbookStorage } from '../_common/PromptbookStorage';
|
|
3
3
|
/**
|
|
4
4
|
* This class behaves like LocalStorage but separates keys by prefix
|
|
5
5
|
*
|
|
@@ -26,12 +26,12 @@ export type PipelineJson = {
|
|
|
26
26
|
* Note: It must be unique across all pipeline collections
|
|
27
27
|
* Note: It must use HTTPs URL
|
|
28
28
|
* Tip: You can do versioning in the URL
|
|
29
|
-
* For example: https://promptbook.studio/webgpt/write-website-content-cs.
|
|
29
|
+
* For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
|
|
30
30
|
* Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
|
|
31
31
|
*/
|
|
32
32
|
readonly pipelineUrl?: string_pipeline_url;
|
|
33
33
|
/**
|
|
34
|
-
* Internal helper for tracking the source `.
|
|
34
|
+
* Internal helper for tracking the source `.book.md` file of the pipeline
|
|
35
35
|
*/
|
|
36
36
|
readonly sourceFile?: string_filename;
|
|
37
37
|
/**
|
|
@@ -40,9 +40,11 @@ export type PipelineJson = {
|
|
|
40
40
|
*/
|
|
41
41
|
readonly title: string_markdown_text;
|
|
42
42
|
/**
|
|
43
|
-
* Version of the
|
|
43
|
+
* Version of the Book language
|
|
44
|
+
*
|
|
45
|
+
* @see https://github.com/webgptorg/book
|
|
44
46
|
*/
|
|
45
|
-
readonly
|
|
47
|
+
readonly bookVersion?: string_semantic_version;
|
|
46
48
|
/**
|
|
47
49
|
* Description of the promptbook
|
|
48
50
|
* It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
|
|
@@ -18,5 +18,5 @@ export type PreparationJson = {
|
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🍙] Make some standard order of json properties
|
|
20
20
|
* TODO: Maybe put here used `modelName`
|
|
21
|
-
* TODO: [🍥] When using `date` it changes all examples .
|
|
21
|
+
* TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
|
|
22
22
|
*/
|
|
@@ -95,7 +95,7 @@ export type CommonPrompt = {
|
|
|
95
95
|
/**
|
|
96
96
|
* Unique identifier of the pipeline with specific template name as hash
|
|
97
97
|
*
|
|
98
|
-
* @example https://promptbook.studio/webgpt/write-website-content-cs.
|
|
98
|
+
* @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
|
|
99
99
|
*/
|
|
100
100
|
readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
|
|
101
101
|
/**
|
|
@@ -298,13 +298,13 @@ export type string_base_url = string;
|
|
|
298
298
|
/**
|
|
299
299
|
* Semantic helper
|
|
300
300
|
*
|
|
301
|
-
* For example `"https://promptbook.studio/webgpt/write-website-content-cs.
|
|
301
|
+
* For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
|
|
302
302
|
*/
|
|
303
303
|
export type string_pipeline_url = string;
|
|
304
304
|
/**
|
|
305
305
|
* Semantic helper
|
|
306
306
|
*
|
|
307
|
-
* For example `"https://promptbook.studio/webgpt/write-website-content-cs.
|
|
307
|
+
* For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
|
|
308
308
|
*/
|
|
309
309
|
export type string_pipeline_url_with_hashtemplate = string;
|
|
310
310
|
/**
|
|
@@ -1,6 +1,17 @@
|
|
|
1
1
|
import type { string_semantic_version } from './types/typeAliases';
|
|
2
2
|
/**
|
|
3
|
-
* The version of the
|
|
3
|
+
* The version of the Book language
|
|
4
|
+
*
|
|
5
|
+
* @see https://github.com/webgptorg/book
|
|
4
6
|
*/
|
|
5
|
-
export declare const
|
|
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/browser",
|
|
3
|
-
"version": "0.74.0-
|
|
3
|
+
"version": "0.74.0-12",
|
|
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/browser.index.d.ts",
|
|
55
55
|
"peerDependencies": {
|
|
56
|
-
"@promptbook/core": "0.74.0-
|
|
56
|
+
"@promptbook/core": "0.74.0-12"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
59
|
"spacetrim": "0.11.59"
|
package/umd/index.umd.js
CHANGED
|
@@ -10,10 +10,20 @@
|
|
|
10
10
|
|
|
11
11
|
// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
|
|
12
12
|
/**
|
|
13
|
-
* The version of the
|
|
13
|
+
* The version of the Book language
|
|
14
|
+
*
|
|
15
|
+
* @see https://github.com/webgptorg/book
|
|
16
|
+
*/
|
|
17
|
+
var BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
18
|
+
/**
|
|
19
|
+
* The version of the Promptbook engine
|
|
20
|
+
*
|
|
21
|
+
* @see https://github.com/webgptorg/promptbook
|
|
22
|
+
*/
|
|
23
|
+
var PROMPTBOOK_ENGINE_VERSION = '0.74.0-11';
|
|
24
|
+
/**
|
|
25
|
+
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
14
26
|
*/
|
|
15
|
-
var PROMPTBOOK_VERSION = '0.73.0';
|
|
16
|
-
// TODO: [main] !!!! List here all the versions and annotate + put into script
|
|
17
27
|
|
|
18
28
|
/*! *****************************************************************************
|
|
19
29
|
Copyright (c) Microsoft Corporation.
|
|
@@ -715,7 +725,7 @@
|
|
|
715
725
|
return pipelineJsonStringified;
|
|
716
726
|
}
|
|
717
727
|
/**
|
|
718
|
-
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.
|
|
728
|
+
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
|
|
719
729
|
* TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
|
|
720
730
|
* TODO: [🧠] Maybe more elegant solution than replacing via regex
|
|
721
731
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -785,7 +795,8 @@
|
|
|
785
795
|
*/
|
|
786
796
|
|
|
787
797
|
exports.$provideScrapersForBrowser = $provideScrapersForBrowser;
|
|
788
|
-
exports.
|
|
798
|
+
exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
|
|
799
|
+
exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
|
|
789
800
|
exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
|
|
790
801
|
exports.getLocalStorage = getLocalStorage;
|
|
791
802
|
exports.getSessionStorage = getSessionStorage;
|