@promptbook/legacy-documents 0.100.0-4 → 0.100.0-40

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 (62) hide show
  1. package/README.md +1 -0
  2. package/esm/index.es.js +150 -3
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/components.index.d.ts +4 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +26 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +30 -0
  7. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
  8. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
  9. package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
  10. package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
  11. package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
  12. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/FrontendRAGService.d.ts +48 -0
  13. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +51 -0
  14. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts +54 -0
  15. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts +45 -0
  16. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts +31 -0
  17. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts +23 -0
  18. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts +18 -0
  19. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts +56 -0
  20. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts +34 -0
  21. package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
  22. package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
  23. package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
  24. package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
  25. package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
  26. package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
  27. package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
  28. package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
  29. package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
  30. package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
  31. package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
  32. package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
  33. package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
  34. package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
  35. package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
  36. package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
  37. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +61 -0
  38. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +35 -0
  39. package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
  40. package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
  41. package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
  42. package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
  43. package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
  44. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +30 -0
  45. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
  46. package/esm/typings/src/config.d.ts +6 -0
  47. package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
  48. package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
  49. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
  50. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
  51. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  52. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  53. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  54. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
  55. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  56. package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
  57. package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
  58. package/esm/typings/src/types/typeAliases.d.ts +6 -0
  59. package/esm/typings/src/version.d.ts +1 -1
  60. package/package.json +2 -2
  61. package/umd/index.umd.js +150 -3
  62. package/umd/index.umd.js.map +1 -1
@@ -0,0 +1,24 @@
1
+ import type { AgentBasicInformation } from '../../agent-source/parseAgentSource';
2
+ import type { string_book } from '../../agent-source/string_book';
3
+ import type { AgentSourceParseResult } from './AgentSourceParseResult';
4
+ /**
5
+ * Parses agent source using the new commitment system with multiline support
6
+ * This function replaces the hardcoded commitment parsing in the original parseAgentSource
7
+ *
8
+ * @private
9
+ */
10
+ export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
11
+ /**
12
+ * Extracts basic information from agent source using the new commitment system
13
+ * This maintains compatibility with the original parseAgentSource interface
14
+ *
15
+ * @private
16
+ */
17
+ export declare function parseAgentSourceBasicInfo(agentSource: string_book): AgentBasicInformation;
18
+ /**
19
+ * Extracts META LINK commitments from agent source
20
+ * Returns an array of all META LINK URLs found in the agent source
21
+ *
22
+ * @private
23
+ */
24
+ export declare function extractMetaLinks(agentSource: string_book): string[];
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Removes comment lines (lines starting with #) from a system message
3
+ * This is used to clean up the final system message before sending it to the AI model
4
+ * while preserving the original content with comments in metadata
5
+ *
6
+ * @param systemMessage The system message that may contain comment lines
7
+ * @returns The system message with comment lines removed
8
+ *
9
+ * @private - TODO: [🧠] Maybe should be public?
10
+ */
11
+ export declare function removeCommentsFromSystemMessage(systemMessage: string): string;
@@ -0,0 +1,56 @@
1
+ import type { BookCommitment } from './_base/BookCommitment';
2
+ import type { CommitmentDefinition } from './_base/CommitmentDefinition';
3
+ import { ActionCommitmentDefinition } from './ACTION/ACTION';
4
+ import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
5
+ import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
6
+ import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
7
+ import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
8
+ import { ModelCommitmentDefinition } from './MODEL/MODEL';
9
+ import { NoteCommitmentDefinition } from './NOTE/NOTE';
10
+ import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
11
+ import { RuleCommitmentDefinition } from './RULE/RULE';
12
+ import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
13
+ import { StyleCommitmentDefinition } from './STYLE/STYLE';
14
+ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
15
+ /**
16
+ * Registry of all available commitment definitions
17
+ * This array contains instances of all commitment definitions
18
+ * This is the single source of truth for all commitments in the system
19
+ *
20
+ * @private Use functions to access commitments instead of this array directly
21
+ */
22
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
23
+ /**
24
+ * Gets a commitment definition by its type
25
+ * @param type The commitment type to look up
26
+ * @returns The commitment definition or null if not found
27
+ *
28
+ * @public exported from `@promptbook/core`
29
+ */
30
+ export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
31
+ /**
32
+ * Gets all available commitment definitions
33
+ * @returns Array of all commitment definitions
34
+ *
35
+ * @public exported from `@promptbook/core`
36
+ */
37
+ export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
38
+ /**
39
+ * Gets all available commitment types
40
+ * @returns Array of all commitment types
41
+ *
42
+ * @public exported from `@promptbook/core`
43
+ */
44
+ export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
45
+ /**
46
+ * Checks if a commitment type is supported
47
+ * @param type The commitment type to check
48
+ * @returns True if the commitment type is supported
49
+ *
50
+ * @public exported from `@promptbook/core`
51
+ */
52
+ export declare function isCommitmentSupported(type: BookCommitment): boolean;
53
+ /**
54
+ * TODO: !!!! Maybe create through standardized $register
55
+ * Note: [💞] Ignore a discrepancy between file name and entity name
56
+ */
@@ -0,0 +1,39 @@
1
+ import type { string_url_image } from '../../types/typeAliases';
2
+ /**
3
+ * Extracts profile image URL from agent definition text and returns cleaned system message
4
+ * @param systemMessage The original system message that may contain META IMAGE line
5
+ * @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
6
+ *
7
+ * @private - TODO: [🧠] Maybe should be public?
8
+ */
9
+ export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
10
+ profileImageUrl?: string_url_image;
11
+ cleanedSystemMessage: string;
12
+ };
13
+ /**
14
+ * Extracts persona, examples, and profile image from agent definition text
15
+ * @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
16
+ * @returns Object with extracted information and cleaned system message
17
+ *
18
+ * @private - TODO: [🧠] Maybe should be public?
19
+ */
20
+ export declare function extractAgentMetadata(systemMessage: string): {
21
+ persona?: {
22
+ name: string;
23
+ description?: string;
24
+ };
25
+ examples: string[];
26
+ profileImageUrl?: string_url_image;
27
+ cleanedSystemMessage: string;
28
+ };
29
+ /**
30
+ * Generates a gravatar URL based on agent name for fallback avatar
31
+ * @param name The agent name to generate avatar for
32
+ * @returns Gravatar URL
33
+ *
34
+ * @private - TODO: [🧠] Maybe should be public?
35
+ */
36
+ export declare function generateGravatarUrl(name?: string | null): string;
37
+ /**
38
+ * Note: [💞] Ignore a discrepancy between file name and entity name
39
+ */
@@ -0,0 +1,30 @@
1
+ import type { string_book } from '../../book-2.0/agent-source/string_book';
2
+ export interface BookEditorProps {
3
+ /**
4
+ * Additional CSS classes to apply to the editor container.
5
+ */
6
+ readonly className?: string;
7
+ /**
8
+ * CSS className for a font (e.g. from next/font) to style the editor text.
9
+ * If omitted, defaults to system serif fonts.
10
+ */
11
+ readonly fontClassName?: string;
12
+ /**
13
+ * The book which is being edited.
14
+ */
15
+ readonly value?: string_book;
16
+ /**
17
+ * Callback function to handle changes in the book content.
18
+ */
19
+ onChange?(value: string_book): void;
20
+ /**
21
+ * If true, logs verbose debug info to the console and shows additional visual cues
22
+ */
23
+ readonly isVerbose?: boolean;
24
+ }
25
+ /**
26
+ * Renders a book editor
27
+ *
28
+ * @public exported from `@promptbook/components`
29
+ */
30
+ export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,7 @@
1
+ import type { string_css_class } from '../../../types/typeAliases';
2
+ /**
3
+ * Utility function for joining multiple truthy class names into one string
4
+ *
5
+ * @private within the `@promptbook/components`
6
+ */
7
+ export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
281
281
  * @public exported from `@promptbook/core`
282
282
  */
283
283
  export declare const DEFAULT_IS_AUTO_INSTALLED = false;
284
+ /**
285
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
286
+ *
287
+ * @public exported from `@promptbook/core`
288
+ */
289
+ export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
284
290
  /**
285
291
  * Function name for generated function via `ptbk make` to get the pipeline collection
286
292
  *
@@ -40,6 +40,10 @@ export type AvailableModel = {
40
40
  readonly prompt: number_usd;
41
41
  readonly output: number_usd;
42
42
  };
43
+ /**
44
+ * If the model is deprecated, it should not be used for new tasks
45
+ */
46
+ readonly isDeprecated?: boolean;
43
47
  };
44
48
  /**
45
49
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
@@ -1,5 +1,6 @@
1
1
  import type { Observable } from 'rxjs';
2
2
  import { PartialDeep } from 'type-fest';
3
+ import type { number_percent } from '../types/typeAliases';
3
4
  import type { task_id } from '../types/typeAliases';
4
5
  import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
5
6
  import type { string_promptbook_version } from '../version';
@@ -28,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
28
29
  */
29
30
  readonly title?: AbstractTask<TTaskResult>['title'];
30
31
  }) => void): Promise<TTaskResult>;
32
+ /**
33
+ * Optional callback to provide custom tldr information
34
+ * @param createdAt When the task was created
35
+ * @param status Current task status
36
+ * @param currentValue Current partial result
37
+ * @param errors Current errors
38
+ * @param warnings Current warnings
39
+ * @returns Custom tldr information
40
+ */
41
+ tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
42
+ readonly percent: number_percent;
43
+ readonly message: string;
44
+ };
31
45
  };
32
46
  /**
33
47
  * Helper to create a new task
@@ -80,6 +94,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
80
94
  * Status of the task
81
95
  */
82
96
  readonly status: task_status;
97
+ /**
98
+ * Short summary of the task status for quick overview in the UI
99
+ */
100
+ readonly tldr: {
101
+ /**
102
+ * Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
103
+ */
104
+ readonly percent: number_percent;
105
+ /**
106
+ * Short summary message of the task status that can be displayed in the UI
107
+ */
108
+ readonly message: string;
109
+ };
83
110
  /**
84
111
  * Date when the task was created
85
112
  */
@@ -1,10 +1,11 @@
1
- import type { ReadonlyDeep, WritableDeep } from 'type-fest';
1
+ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
4
  import type { Parameters } from '../../types/typeAliases';
5
5
  import type { string_parameter_name } from '../../types/typeAliases';
6
6
  import type { TODO_string } from '../../utils/organization/TODO_string';
7
7
  import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
8
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
8
9
  import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
9
10
  /**
10
11
  * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
@@ -46,6 +47,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
46
47
  * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
47
48
  */
48
49
  readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
50
+ /**
51
+ * Callback invoked with partial results as the execution progresses.
52
+ */
53
+ onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
49
54
  /**
50
55
  * The execution report object, which is updated during execution.
51
56
  */
@@ -2,7 +2,6 @@ import Anthropic from '@anthropic-ai/sdk';
2
2
  import type { AvailableModel } from '../../execution/AvailableModel';
3
3
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
4
  import type { ChatPromptResult } from '../../execution/PromptResult';
5
- import type { CompletionPromptResult } from '../../execution/PromptResult';
6
5
  import type { Prompt } from '../../types/Prompt';
7
6
  import type { string_markdown } from '../../types/typeAliases';
8
7
  import type { string_markdown_text } from '../../types/typeAliases';
@@ -42,10 +41,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
42
41
  * Calls Anthropic Claude API to use a chat model.
43
42
  */
44
43
  callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
45
- /**
46
- * Calls Anthropic Claude API to use a completion model.
47
- */
48
- callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
49
44
  /**
50
45
  * Get the model that should be used as default
51
46
  */
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
3
3
  /**
4
4
  * List of available Anthropic Claude models with pricing
5
5
  *
6
- * Note: Done at 2025-05-06
6
+ * Note: Synced with official API docs at 2025-08-20
7
7
  *
8
8
  * @see https://docs.anthropic.com/en/docs/models-overview
9
9
  * @public exported from `@promptbook/anthropic-claude`
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
3
3
  /**
4
4
  * List of available Deepseek models with descriptions
5
5
  *
6
- * Note: Done at 2025-05-06
6
+ * Note: Synced with official API docs at 2025-08-20
7
7
  *
8
8
  * @see https://www.deepseek.com/models
9
9
  * @public exported from `@promptbook/deepseek`
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
3
3
  /**
4
4
  * List of available Google models with descriptions
5
5
  *
6
- * Note: Done at 2025-05-06
6
+ * Note: Synced with official API docs at 2025-08-20
7
7
  *
8
8
  * @see https://ai.google.dev/models/gemini
9
9
  * @public exported from `@promptbook/google`
@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
2
2
  /**
3
3
  * List of available models in Ollama library
4
4
  *
5
- * Note: Done at 2025-05-19
5
+ * Note: Synced with official API docs at 2025-08-20
6
6
  *
7
7
  * @see https://ollama.com/library
8
8
  * @public exported from `@promptbook/ollama`
@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
2
2
  /**
3
3
  * List of available OpenAI models with pricing
4
4
  *
5
- * Note: Done at 2025-05-06
5
+ * Note: Synced with official API docs at 2025-08-20
6
6
  *
7
7
  * @see https://platform.openai.com/docs/models/
8
8
  * @see https://openai.com/api/pricing/
@@ -1,3 +1,4 @@
1
+ import type { string_book } from '../book-2.0/agent-source/string_book';
1
2
  import type { PipelineString } from './PipelineString';
2
3
  /**
3
4
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
@@ -12,7 +13,7 @@ import type { PipelineString } from './PipelineString';
12
13
  * @returns the pipeline string
13
14
  * @public exported from `@promptbook/core`
14
15
  */
15
- export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
16
+ export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
16
17
  /**
17
18
  * TODO: [🧠][🈴] Where is the best location for this file
18
19
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -87,8 +87,6 @@ export type CommonModelRequirements = {
87
87
  readonly seed?: number_seed;
88
88
  /**
89
89
  * Maximum number of tokens that can be generated by the model
90
- *
91
- * Note: [🌾]
92
90
  */
93
91
  readonly maxTokens?: number;
94
92
  };
@@ -136,6 +136,12 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
136
136
  * For example `"Ai*nautes"`
137
137
  */
138
138
  export type string_title = string;
139
+ /**
140
+ * Semantic helper
141
+ *
142
+ * For example `"My AI Assistant"`
143
+ */
144
+ export type string_agent_name = string;
139
145
  /**
140
146
  * Unstructured description of the persona
141
147
  *
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.100.0-3`).
18
+ * It follows semantic versioning (e.g., `0.100.0-39`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/legacy-documents",
3
- "version": "0.100.0-4",
3
+ "version": "0.100.0-40",
4
4
  "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -95,7 +95,7 @@
95
95
  "module": "./esm/index.es.js",
96
96
  "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.100.0-4"
98
+ "@promptbook/core": "0.100.0-40"
99
99
  },
100
100
  "dependencies": {
101
101
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -26,7 +26,7 @@
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0-4';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.0-40';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -218,6 +218,12 @@
218
218
  * @public exported from `@promptbook/core`
219
219
  */
220
220
  const DEFAULT_IS_AUTO_INSTALLED = false;
221
+ /**
222
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
223
+ *
224
+ * @public exported from `@promptbook/core`
225
+ */
226
+ const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
221
227
  /**
222
228
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
223
229
  *
@@ -2685,7 +2691,7 @@
2685
2691
  * @private internal helper function
2686
2692
  */
2687
2693
  function createTask(options) {
2688
- const { taskType, taskProcessCallback } = options;
2694
+ const { taskType, taskProcessCallback, tldrProvider } = options;
2689
2695
  let { title } = options;
2690
2696
  // TODO: [🐙] DRY
2691
2697
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
@@ -2758,6 +2764,78 @@
2758
2764
  return status;
2759
2765
  // <- Note: [1] --||--
2760
2766
  },
2767
+ get tldr() {
2768
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2769
+ // Use custom tldr provider if available
2770
+ if (tldrProvider) {
2771
+ return tldrProvider(createdAt, status, currentValue, errors, warnings);
2772
+ }
2773
+ // Fallback to default implementation
2774
+ const cv = currentValue;
2775
+ // If explicit percent is provided, use it
2776
+ let percentRaw = (_f = (_d = (_b = (_a = cv === null || cv === void 0 ? void 0 : cv.tldr) === null || _a === void 0 ? void 0 : _a.percent) !== null && _b !== void 0 ? _b : (_c = cv === null || cv === void 0 ? void 0 : cv.usage) === null || _c === void 0 ? void 0 : _c.percent) !== null && _d !== void 0 ? _d : (_e = cv === null || cv === void 0 ? void 0 : cv.progress) === null || _e === void 0 ? void 0 : _e.percent) !== null && _f !== void 0 ? _f : cv === null || cv === void 0 ? void 0 : cv.percent;
2777
+ // Simulate progress if not provided
2778
+ if (typeof percentRaw !== 'number') {
2779
+ // Simulate progress: evenly split across subtasks, based on elapsed time
2780
+ const now = new Date();
2781
+ const elapsedMs = now.getTime() - createdAt.getTime();
2782
+ const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
2783
+ // If subtasks are defined, split progress evenly
2784
+ const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
2785
+ const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
2786
+ ? cv.subtasks.filter((s) => s.done || s.completed).length
2787
+ : 0;
2788
+ // Progress from completed subtasks
2789
+ const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
2790
+ // Progress from elapsed time for current subtask
2791
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
2792
+ // Combine: completed subtasks + time progress for current subtask
2793
+ percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
2794
+ if (status === 'FINISHED')
2795
+ percentRaw = 1;
2796
+ if (status === 'ERROR')
2797
+ percentRaw = 0;
2798
+ }
2799
+ // Clamp to [0,1]
2800
+ let percent = Number(percentRaw) || 0;
2801
+ if (percent < 0)
2802
+ percent = 0;
2803
+ if (percent > 1)
2804
+ percent = 1;
2805
+ // Build a short message: prefer explicit tldr.message, then common summary/message fields, then errors/warnings, then status
2806
+ const messageFromResult = (_k = (_j = (_h = (_g = cv === null || cv === void 0 ? void 0 : cv.tldr) === null || _g === void 0 ? void 0 : _g.message) !== null && _h !== void 0 ? _h : cv === null || cv === void 0 ? void 0 : cv.message) !== null && _j !== void 0 ? _j : cv === null || cv === void 0 ? void 0 : cv.summary) !== null && _k !== void 0 ? _k : cv === null || cv === void 0 ? void 0 : cv.statusMessage;
2807
+ let message = messageFromResult;
2808
+ if (!message) {
2809
+ // If subtasks, show current subtask
2810
+ if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
2811
+ const current = cv.subtasks.find((s) => !s.done && !s.completed);
2812
+ if (current && current.title) {
2813
+ message = `Working on ${current.title}`;
2814
+ }
2815
+ }
2816
+ if (!message) {
2817
+ if (errors.length) {
2818
+ message = errors[errors.length - 1].message || 'Error';
2819
+ }
2820
+ else if (warnings.length) {
2821
+ message = warnings[warnings.length - 1].message || 'Warning';
2822
+ }
2823
+ else if (status === 'FINISHED') {
2824
+ message = 'Finished';
2825
+ }
2826
+ else if (status === 'ERROR') {
2827
+ message = 'Error';
2828
+ }
2829
+ else {
2830
+ message = 'Running';
2831
+ }
2832
+ }
2833
+ }
2834
+ return {
2835
+ percent: percent,
2836
+ message,
2837
+ };
2838
+ },
2761
2839
  get createdAt() {
2762
2840
  return createdAt;
2763
2841
  // <- Note: [1] --||--
@@ -5105,7 +5183,7 @@
5105
5183
  */
5106
5184
  async function executeAttempts(options) {
5107
5185
  const { jokerParameterNames, priority, maxAttempts, // <- Note: [💂]
5108
- preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, } = options;
5186
+ preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, } = options;
5109
5187
  const $ongoingTaskResult = {
5110
5188
  $result: null,
5111
5189
  $resultString: null,
@@ -5349,6 +5427,10 @@
5349
5427
  result: $ongoingTaskResult.$resultString,
5350
5428
  error: error,
5351
5429
  });
5430
+ // Report failed attempt
5431
+ onProgress({
5432
+ errors: [error],
5433
+ });
5352
5434
  }
5353
5435
  finally {
5354
5436
  if (!isJokerAttempt &&
@@ -6230,6 +6312,71 @@
6230
6312
  updateOngoingResult(newOngoingResult);
6231
6313
  });
6232
6314
  },
6315
+ tldrProvider(createdAt, status, currentValue, errors) {
6316
+ var _a;
6317
+ // Better progress estimation based on pipeline structure
6318
+ const cv = currentValue;
6319
+ // Handle finished/error states
6320
+ if (status === 'FINISHED') {
6321
+ return {
6322
+ percent: 1,
6323
+ message: 'Finished',
6324
+ };
6325
+ }
6326
+ if (status === 'ERROR') {
6327
+ const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
6328
+ return {
6329
+ percent: 0,
6330
+ message: errorMessage,
6331
+ };
6332
+ }
6333
+ // Calculate progress based on pipeline tasks
6334
+ const totalTasks = pipeline.tasks.length;
6335
+ let completedTasks = 0;
6336
+ let currentTaskName = '';
6337
+ // Check execution report for completed tasks
6338
+ if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
6339
+ const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
6340
+ // Count completed tasks by matching titles
6341
+ const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
6342
+ completedTasks = completedTasksByTitle.length;
6343
+ // Find current task being executed (first task not yet completed)
6344
+ const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
6345
+ if (remainingTasks.length > 0) {
6346
+ currentTaskName = remainingTasks[0].name;
6347
+ }
6348
+ }
6349
+ // Calculate progress percentage
6350
+ let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
6351
+ // Add time-based progress for current task (assuming 5 minutes total)
6352
+ if (completedTasks < totalTasks) {
6353
+ const elapsedMs = new Date().getTime() - createdAt.getTime();
6354
+ const totalMs = 5 * 60 * 1000; // 5 minutes
6355
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
6356
+ // Add partial progress for current task
6357
+ percent += (1 / totalTasks) * timeProgress;
6358
+ }
6359
+ // Clamp to [0,1]
6360
+ percent = Math.min(Math.max(percent, 0), 1);
6361
+ // Generate message
6362
+ let message = '';
6363
+ if (currentTaskName) {
6364
+ // Find the task to get its title
6365
+ const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
6366
+ const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
6367
+ message = `Working on task ${taskTitle}`;
6368
+ }
6369
+ else if (completedTasks === 0) {
6370
+ message = 'Starting pipeline execution';
6371
+ }
6372
+ else {
6373
+ message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
6374
+ }
6375
+ return {
6376
+ percent,
6377
+ message,
6378
+ };
6379
+ },
6233
6380
  });
6234
6381
  // <- TODO: Make types such as there is no need to do `as` for `createTask`
6235
6382
  return pipelineExecutor;