@promptbook/editable 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.
- package/README.md +1 -0
- package/esm/index.es.js +1 -1
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/components.index.d.ts +4 -0
- package/esm/typings/src/_packages/core.index.d.ts +26 -0
- package/esm/typings/src/_packages/types.index.d.ts +30 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
- package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
- package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/FrontendRAGService.d.ts +48 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +51 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts +54 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts +45 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts +31 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts +23 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts +18 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts +56 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts +34 -0
- package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
- package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
- package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
- package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
- package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
- package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
- package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
- package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +61 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +35 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
- package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
- package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
- package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
- package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +30 -0
- package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
- package/esm/typings/src/config.d.ts +6 -0
- package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
- package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
- package/esm/typings/src/types/typeAliases.d.ts +6 -0
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
- package/umd/index.umd.js.map +1 -1
@@ -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:
|
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:
|
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:
|
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:
|
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:
|
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
|
@@ -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-
|
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/editable",
|
3
|
-
"version": "0.100.0-
|
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/editable.index.d.ts",
|
97
97
|
"peerDependencies": {
|
98
|
-
"@promptbook/core": "0.100.0-
|
98
|
+
"@promptbook/core": "0.100.0-40"
|
99
99
|
},
|
100
100
|
"dependencies": {
|
101
101
|
"crypto-js": "4.2.0",
|
package/umd/index.umd.js
CHANGED
@@ -23,7 +23,7 @@
|
|
23
23
|
* @generated
|
24
24
|
* @see https://github.com/webgptorg/promptbook
|
25
25
|
*/
|
26
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.100.0-
|
26
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.100.0-40';
|
27
27
|
/**
|
28
28
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
29
29
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|