@promptbook/wizard 0.100.0-4 → 0.100.0-41

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 (70) hide show
  1. package/README.md +1 -0
  2. package/esm/index.es.js +424 -87
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/components.index.d.ts +14 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +26 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +34 -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/AvatarProfile/AvatarChip/AvatarChip.d.ts +35 -0
  45. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts +21 -0
  46. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts +2 -0
  47. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +35 -0
  48. package/esm/typings/src/book-components/BookEditor/config.d.ts +10 -0
  49. package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts +11 -0
  50. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
  51. package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts +7 -0
  52. package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts +6 -0
  53. package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts +6 -0
  54. package/esm/typings/src/config.d.ts +6 -0
  55. package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
  56. package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
  57. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
  58. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
  59. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  60. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  61. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  62. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
  63. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  64. package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
  65. package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
  66. package/esm/typings/src/types/typeAliases.d.ts +6 -0
  67. package/esm/typings/src/version.d.ts +1 -1
  68. package/package.json +2 -2
  69. package/umd/index.umd.js +424 -87
  70. package/umd/index.umd.js.map +1 -1
@@ -0,0 +1,35 @@
1
+ import type { string_book } from '../../agent-source/string_book';
2
+ import type { AgentModelRequirements } from './AgentModelRequirements';
3
+ /**
4
+ * Creates agent model requirements using the new commitment system
5
+ * This function uses a reduce-like pattern where each commitment applies its changes
6
+ * to build the final requirements starting from a basic empty model
7
+ *
8
+ * @private
9
+ */
10
+ export declare function createAgentModelRequirementsWithCommitments(agentSource: string_book, modelName?: string): Promise<AgentModelRequirements>;
11
+ /**
12
+ * Cached version of createAgentModelRequirementsWithCommitments
13
+ * This maintains the same caching behavior as the original function
14
+ *
15
+ * @private
16
+ */
17
+ export declare function createAgentModelRequirementsWithCommitmentsCached(agentSource: string_book, modelName?: string): Promise<AgentModelRequirements>;
18
+ /**
19
+ * Clears the cache for createAgentModelRequirementsWithCommitments
20
+ *
21
+ * @private
22
+ */
23
+ export declare function clearAgentModelRequirementsWithCommitmentsCache(): void;
24
+ /**
25
+ * Removes cache entries for a specific agent source
26
+ *
27
+ * @private
28
+ */
29
+ export declare function invalidateAgentModelRequirementsWithCommitmentsCache(agentSource: string_book): void;
30
+ /**
31
+ * Gets the current cache size
32
+ *
33
+ * @private
34
+ */
35
+ export declare function getAgentModelRequirementsWithCommitmentsCacheSize(): number;
@@ -0,0 +1,20 @@
1
+ import type { BookCommitment } from '../_base/BookCommitment';
2
+ /**
3
+ * Generates a regex pattern to match a specific commitment
4
+ *
5
+ * Note: It always creates new Regex object
6
+ * Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
7
+ *
8
+ * @private
9
+ */
10
+ export declare function createCommitmentRegex(commitment: BookCommitment): RegExp;
11
+ /**
12
+ * Generates a regex pattern to match a specific commitment type
13
+ *
14
+ * Note: It just matches the type part of the commitment
15
+ * Note: It always creates new Regex object
16
+ * Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
17
+ *
18
+ * @private
19
+ */
20
+ export declare function createCommitmentTypeRegex(commitment: BookCommitment): RegExp;
@@ -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,35 @@
1
+ import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
2
+ import type { string_css_class } from '../../../types/typeAliases';
3
+ /**
4
+ * Props of `AvatarChip`
5
+ *
6
+ * @public exported from `@promptbook/components`
7
+ */
8
+ export type AvatarChipProps = {
9
+ /**
10
+ * Avatar to be shown
11
+ */
12
+ readonly avatarBasicInformation: AgentBasicInformation;
13
+ /**
14
+ * Whether this chip is a template avatar
15
+ */
16
+ readonly isTemplate: boolean;
17
+ /**
18
+ * Optional CSS class name which will be added to root <div> element
19
+ */
20
+ readonly className?: string_css_class;
21
+ /**
22
+ * Called when chip is clicked
23
+ */
24
+ readonly onSelect?: (avatar: AgentBasicInformation) => void;
25
+ /**
26
+ * Whether this chip is selected
27
+ */
28
+ readonly isSelected?: boolean;
29
+ };
30
+ /**
31
+ * Shows a chip with avatar's avatar and name
32
+ *
33
+ * @public exported from `@promptbook/components`
34
+ */
35
+ export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,21 @@
1
+ import type { string_book } from '../../../book-2.0/agent-source/string_book';
2
+ import type { AvatarChipProps } from './AvatarChip';
3
+ /**
4
+ * Props of `AvatarChipFromSource`
5
+ *
6
+ * @public exported from `@promptbook/components`
7
+ */
8
+ export type AvatarChipFromSource = Omit<AvatarChipProps, 'avatarBasicInformation'> & {
9
+ /**
10
+ * Avatar to be shown
11
+ */
12
+ readonly source: string_book;
13
+ };
14
+ /**
15
+ * Shows a chip with avatar's avatar and name based on the avatar source string
16
+ *
17
+ * This component is wrapped around the `<AvatarChip/>`, it just parses the avatar source string into `AvatarBasicInformation` and passes it to the `<AvatarChip/>` component.
18
+ *
19
+ * @public exported from `@promptbook/components`
20
+ */
21
+ export declare function AvatarChipFromSource(props: AvatarChipFromSource): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,2 @@
1
+ export * from './AvatarChip';
2
+ export * from './AvatarChipFromSource';
@@ -0,0 +1,35 @@
1
+ import type { string_book } from '../../book-2.0/agent-source/string_book';
2
+ /**
3
+ * Props of `BookEditor`
4
+ *
5
+ * @public exported from `@promptbook/components`
6
+ */
7
+ export type BookEditorProps = {
8
+ /**
9
+ * Additional CSS classes to apply to the editor container.
10
+ */
11
+ readonly className?: string;
12
+ /**
13
+ * CSS className for a font (e.g. from next/font) to style the editor text.
14
+ * If omitted, defaults to system serif fonts.
15
+ */
16
+ readonly fontClassName?: string;
17
+ /**
18
+ * The book which is being edited.
19
+ */
20
+ readonly value?: string_book;
21
+ /**
22
+ * Callback function to handle changes in the book content.
23
+ */
24
+ onChange?(value: string_book): void;
25
+ /**
26
+ * If true, logs verbose debug info to the console and shows additional visual cues
27
+ */
28
+ readonly isVerbose?: boolean;
29
+ };
30
+ /**
31
+ * Renders a book editor
32
+ *
33
+ * @public exported from `@promptbook/components`
34
+ */
35
+ export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Default font class name for the BookEditor component
3
+ * In Next.js environments, you can override this by importing the font directly
4
+ *
5
+ * @public exported from `@promptbook/components`
6
+ */
7
+ export declare const DEFAULT_BOOK_FONT_CLASS: any;
8
+ /**
9
+ * Note: [💞] Ignore a discrepancy between file name and entity name
10
+ */
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
3
+ * This allows CSS modules (which are normally emitted into the document head) to be
4
+ * available inside the component's shadow DOM.
5
+ *
6
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
7
+ */
8
+ export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
9
+ /**
10
+ * TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
11
+ */
@@ -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;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Collect matching CSS texts from document stylesheets for a given class.
3
+ * This will skip cross-origin stylesheets (they throw when accessed).
4
+ *
5
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
6
+ */
7
+ export declare function collectCssTextsForClass(className: string): string[];
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Escape HTML to safely render user text inside a <pre> with dangerouslySetInnerHTML.
3
+ *
4
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
5
+ */
6
+ export declare function escapeHtml(input: string): string;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Escape text for safe use inside a RegExp pattern.
3
+ *
4
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
5
+ */
6
+ export declare function escapeRegex(input: string): string;
@@ -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-40`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/wizard",
3
- "version": "0.100.0-4",
3
+ "version": "0.100.0-41",
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/wizard.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.100.0-4"
98
+ "@promptbook/core": "0.100.0-41"
99
99
  },
100
100
  "dependencies": {
101
101
  "@ai-sdk/deepseek": "0.1.6",