@promptbook/remote-client 0.100.0 → 0.100.2
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/esm/index.es.js +15 -8
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +2 -2
- package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +2 -2
- package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +2 -2
- package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +2 -2
- package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +2 -2
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +3 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +5 -0
- package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts +4 -4
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +3 -6
- package/esm/typings/src/execution/utils/validatePromptResult.d.ts +4 -4
- package/esm/typings/src/llm-providers/_common/profiles/llmProviderProfiles.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +3 -4
- package/esm/typings/src/utils/color/Color.d.ts +1 -2
- package/esm/typings/src/utils/take/interfaces/ITakeChain.d.ts +2 -2
- package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +1 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/esm/typings/src/wizard/wizard.d.ts +2 -2
- package/package.json +2 -2
- package/umd/index.umd.js +15 -8
- package/umd/index.umd.js.map +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { string_agent_name } from '../../types/typeAliases';
|
|
2
2
|
import type { string_url_image } from '../../types/typeAliases';
|
|
3
3
|
import type { string_book } from './string_book';
|
|
4
|
-
export
|
|
4
|
+
export type AgentBasicInformation = {
|
|
5
5
|
/**
|
|
6
6
|
* Name of the agent
|
|
7
7
|
* This is the first line of the agent source
|
|
@@ -17,7 +17,7 @@ export interface AgentBasicInformation {
|
|
|
17
17
|
* This is the line starting with "META IMAGE"
|
|
18
18
|
*/
|
|
19
19
|
profileImageUrl: string_url_image;
|
|
20
|
-
}
|
|
20
|
+
};
|
|
21
21
|
/**
|
|
22
22
|
* Parses basic information from agent source
|
|
23
23
|
*
|
|
@@ -6,7 +6,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
|
|
|
6
6
|
* - Creating regex patterns for parsing
|
|
7
7
|
* - Applying its effects to agent model requirements
|
|
8
8
|
*/
|
|
9
|
-
export
|
|
9
|
+
export type CommitmentDefinition = {
|
|
10
10
|
/**
|
|
11
11
|
* The type/name of this commitment (e.g., 'PERSONA', 'KNOWLEDGE', etc.)
|
|
12
12
|
*/
|
|
@@ -45,4 +45,4 @@ export interface CommitmentDefinition {
|
|
|
45
45
|
* @returns Updated agent model requirements
|
|
46
46
|
*/
|
|
47
47
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
|
48
|
-
}
|
|
48
|
+
};
|
|
@@ -4,7 +4,7 @@ import type { TODO_any } from '../../../utils/organization/TODO_any';
|
|
|
4
4
|
*
|
|
5
5
|
* This is like "compiled" version of agent source
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type AgentModelRequirements = {
|
|
8
8
|
/**
|
|
9
9
|
* The system message that defines the agent's behavior and personality
|
|
10
10
|
*/
|
|
@@ -34,4 +34,4 @@ export interface AgentModelRequirements {
|
|
|
34
34
|
* Each commitment can store its own data here
|
|
35
35
|
*/
|
|
36
36
|
readonly metadata?: Record<string, TODO_any>;
|
|
37
|
-
}
|
|
37
|
+
};
|
|
@@ -2,7 +2,7 @@ import type { ParsedCommitment } from './ParsedCommitment';
|
|
|
2
2
|
/**
|
|
3
3
|
* Result of parsing agent source for commitments
|
|
4
4
|
*/
|
|
5
|
-
export
|
|
5
|
+
export type AgentSourceParseResult = {
|
|
6
6
|
/**
|
|
7
7
|
* The agent name (first line)
|
|
8
8
|
*/
|
|
@@ -15,4 +15,4 @@ export interface AgentSourceParseResult {
|
|
|
15
15
|
* Lines that are not commitments (for system message)
|
|
16
16
|
*/
|
|
17
17
|
nonCommitmentLines: string[];
|
|
18
|
-
}
|
|
18
|
+
};
|
|
@@ -2,7 +2,7 @@ import type { BookCommitment } from '../_base/BookCommitment';
|
|
|
2
2
|
/**
|
|
3
3
|
* Parsed commitment line from agent source
|
|
4
4
|
*/
|
|
5
|
-
export
|
|
5
|
+
export type ParsedCommitment = {
|
|
6
6
|
/**
|
|
7
7
|
* The commitment type (e.g., 'PERSONA', 'KNOWLEDGE')
|
|
8
8
|
*/
|
|
@@ -19,4 +19,4 @@ export interface ParsedCommitment {
|
|
|
19
19
|
* Line number in the agent source (1-based)
|
|
20
20
|
*/
|
|
21
21
|
lineNumber: number;
|
|
22
|
-
}
|
|
22
|
+
};
|
|
@@ -24,3 +24,6 @@ export type AvatarProfileProps = {
|
|
|
24
24
|
* @public exported from `@promptbook/components`
|
|
25
25
|
*/
|
|
26
26
|
export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
|
|
27
|
+
/**
|
|
28
|
+
* TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
|
|
29
|
+
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { CSSProperties } from 'react';
|
|
1
2
|
import type { string_book } from '../../book-2.0/agent-source/string_book';
|
|
2
3
|
/**
|
|
3
4
|
* Props of `BookEditor`
|
|
@@ -9,6 +10,10 @@ export type BookEditorProps = {
|
|
|
9
10
|
* Additional CSS classes to apply to the editor container.
|
|
10
11
|
*/
|
|
11
12
|
readonly className?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Optional CSS style which will be added to root <div/> element
|
|
15
|
+
*/
|
|
16
|
+
readonly style?: CSSProperties;
|
|
12
17
|
/**
|
|
13
18
|
* CSS className for a font (e.g. from next/font) to style the editor text.
|
|
14
19
|
* If omitted, defaults to system serif fonts.
|
|
@@ -1,7 +1,4 @@
|
|
|
1
|
-
import type { string_color } from '../../../types/typeAliases';
|
|
2
|
-
import type { string_name } from '../../../types/typeAliases';
|
|
3
|
-
import type { string_person_fullname } from '../../../types/typeAliases';
|
|
4
|
-
import type { string_url_image } from '../../../types/typeAliases';
|
|
1
|
+
import type { string_color, string_name, string_person_fullname, string_url_image } from '../../../types/typeAliases';
|
|
5
2
|
import { Color } from '../../../utils/color/Color';
|
|
6
3
|
/**
|
|
7
4
|
* A participant in the chat
|
|
@@ -30,3 +27,6 @@ export type ChatParticipant = {
|
|
|
30
27
|
*/
|
|
31
28
|
color: string_color | Color;
|
|
32
29
|
};
|
|
30
|
+
/**
|
|
31
|
+
* TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
|
|
32
|
+
*/
|
|
@@ -1,13 +1,9 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
2
|
import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
|
|
3
3
|
import type { Prompt } from '../types/Prompt';
|
|
4
|
-
import type { string_markdown } from '../types/typeAliases';
|
|
5
|
-
import type { string_markdown_text } from '../types/typeAliases';
|
|
6
|
-
import type { string_title } from '../types/typeAliases';
|
|
4
|
+
import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
|
|
7
5
|
import type { AvailableModel } from './AvailableModel';
|
|
8
|
-
import type { ChatPromptResult } from './PromptResult';
|
|
9
|
-
import type { CompletionPromptResult } from './PromptResult';
|
|
10
|
-
import type { EmbeddingPromptResult } from './PromptResult';
|
|
6
|
+
import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from './PromptResult';
|
|
11
7
|
/**
|
|
12
8
|
* Container for all the tools needed to execute prompts to large language models like GPT-4
|
|
13
9
|
* On its interface it exposes common methods for prompt execution.
|
|
@@ -60,6 +56,7 @@ export type LlmExecutionTools = {
|
|
|
60
56
|
callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
|
|
61
57
|
};
|
|
62
58
|
/**
|
|
59
|
+
* TODO: [🕛] Extend this from sth class
|
|
63
60
|
* TODO: [🍚] Implement destroyable pattern to free resources
|
|
64
61
|
* TODO: [🏳] Add `callTranslationModel`
|
|
65
62
|
* TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
|
|
@@ -5,7 +5,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
|
|
|
5
5
|
/**
|
|
6
6
|
* Options for validating a prompt result
|
|
7
7
|
*/
|
|
8
|
-
export
|
|
8
|
+
export type ValidatePromptResultOptions = {
|
|
9
9
|
/**
|
|
10
10
|
* The result string to validate
|
|
11
11
|
*/
|
|
@@ -23,11 +23,11 @@ export interface ValidatePromptResultOptions {
|
|
|
23
23
|
* Note: This is for validation purposes only - postprocessing should be done before calling this function
|
|
24
24
|
*/
|
|
25
25
|
postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
|
|
26
|
-
}
|
|
26
|
+
};
|
|
27
27
|
/**
|
|
28
28
|
* Result of prompt result validation
|
|
29
29
|
*/
|
|
30
|
-
export
|
|
30
|
+
export type ValidatePromptResultResult = {
|
|
31
31
|
/**
|
|
32
32
|
* Whether the result is valid (passes all expectations and format checks)
|
|
33
33
|
*/
|
|
@@ -40,7 +40,7 @@ export interface ValidatePromptResultResult {
|
|
|
40
40
|
* Error that occurred during validation, if any
|
|
41
41
|
*/
|
|
42
42
|
error?: ExpectError;
|
|
43
|
-
}
|
|
43
|
+
};
|
|
44
44
|
/**
|
|
45
45
|
* Validates a prompt result against expectations and format requirements.
|
|
46
46
|
* This function provides a common abstraction for result validation that can be used
|
|
@@ -76,6 +76,6 @@ export declare function getLlmProviderProfile(providerKey: keyof typeof LLM_PROV
|
|
|
76
76
|
export declare function createCustomLlmProfile(baseProfile: ChatParticipant, overrides: Partial<ChatParticipant>): ChatParticipant;
|
|
77
77
|
/**
|
|
78
78
|
* TODO: Refactor this - each profile must be alongside the provider definition
|
|
79
|
-
* TODO: Unite `AvatarProfileProps`
|
|
79
|
+
* TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
|
|
80
80
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
81
81
|
*/
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { MODEL_ORDERS } from '../../../constants';
|
|
2
|
-
import {
|
|
3
|
-
import type { string_name } from '../../../types/typeAliases';
|
|
4
|
-
import type { string_title } from '../../../types/typeAliases';
|
|
1
|
+
import { MODEL_ORDERS, MODEL_TRUST_LEVELS } from '../../../constants';
|
|
2
|
+
import type { string_name, string_title } from '../../../types/typeAliases';
|
|
5
3
|
import type { Registered } from '../../../utils/$Register';
|
|
6
4
|
import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
|
|
7
5
|
import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
|
|
@@ -52,6 +50,7 @@ export type LlmToolsMetadata = Registered & {
|
|
|
52
50
|
createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
|
|
53
51
|
};
|
|
54
52
|
/**
|
|
53
|
+
* TODO: [🕛] Extend this
|
|
55
54
|
* TODO: Add configuration schema and maybe some documentation link
|
|
56
55
|
* TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
|
|
57
56
|
* TODO: [®] DRY Register logic
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import type { string_color } from '../../types/typeAliases';
|
|
2
|
-
import type { string_url_image } from '../../types/typeAliases';
|
|
1
|
+
import type { string_color, string_url_image } from '../../types/typeAliases';
|
|
3
2
|
import type { WithTake } from '../take/interfaces/ITakeChain';
|
|
4
3
|
import { CSS_COLORS } from './css-colors';
|
|
5
4
|
/**
|
|
@@ -6,7 +6,7 @@ import type { Takeable } from './Takeable';
|
|
|
6
6
|
* @deprecated [🤡] Use some better functional library instead of `TakeChain`
|
|
7
7
|
*/
|
|
8
8
|
export type WithTake<TValue extends Takeable> = TValue & ITakeChain<TValue>;
|
|
9
|
-
export
|
|
9
|
+
export type ITakeChain<TValue extends Takeable> = {
|
|
10
10
|
readonly value: TValue;
|
|
11
11
|
then<TResultValue extends Takeable>(callback: (value: TValue) => TResultValue): WithTake<TResultValue>;
|
|
12
|
-
}
|
|
12
|
+
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { string_filename } from '../../../types/typeAliases';
|
|
2
2
|
import type { really_unknown } from '../../organization/really_unknown';
|
|
3
3
|
/**
|
|
4
|
-
* Tests if given string is valid
|
|
4
|
+
* Tests if given string is valid file path.
|
|
5
5
|
*
|
|
6
6
|
* Note: This does not check if the file exists only if the path is valid
|
|
7
7
|
* @public exported from `@promptbook/utils`
|
|
@@ -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.
|
|
18
|
+
* It follows semantic versioning (e.g., `0.100.1`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
|
@@ -9,12 +9,12 @@ import type { string_pipeline_url } from '../types/typeAliases';
|
|
|
9
9
|
/**
|
|
10
10
|
* Options for wizard methods
|
|
11
11
|
*/
|
|
12
|
-
|
|
12
|
+
type WizardOptions = {
|
|
13
13
|
/**
|
|
14
14
|
* Whether to enable verbose logging
|
|
15
15
|
*/
|
|
16
16
|
isVerbose?: boolean;
|
|
17
|
-
}
|
|
17
|
+
};
|
|
18
18
|
/**
|
|
19
19
|
* Wizard for simple usage of the Promptbook
|
|
20
20
|
* Look at `wizard` for more details
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/remote-client",
|
|
3
|
-
"version": "0.100.
|
|
3
|
+
"version": "0.100.2",
|
|
4
4
|
"description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
"module": "./esm/index.es.js",
|
|
101
101
|
"typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
|
|
102
102
|
"peerDependencies": {
|
|
103
|
-
"@promptbook/core": "0.100.
|
|
103
|
+
"@promptbook/core": "0.100.2"
|
|
104
104
|
},
|
|
105
105
|
"dependencies": {
|
|
106
106
|
"crypto": "1.0.1",
|
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.
|
|
26
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.100.2';
|
|
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
|
|
@@ -710,7 +710,7 @@
|
|
|
710
710
|
];
|
|
711
711
|
|
|
712
712
|
/**
|
|
713
|
-
* Tests if given string is valid
|
|
713
|
+
* Tests if given string is valid file path.
|
|
714
714
|
*
|
|
715
715
|
* Note: This does not check if the file exists only if the path is valid
|
|
716
716
|
* @public exported from `@promptbook/utils`
|
|
@@ -722,18 +722,25 @@
|
|
|
722
722
|
if (filename.split('\n').length > 1) {
|
|
723
723
|
return false;
|
|
724
724
|
}
|
|
725
|
-
|
|
726
|
-
|
|
725
|
+
// Normalize slashes early so heuristics can detect path-like inputs
|
|
726
|
+
const filenameSlashes = filename.replace(/\\/g, '/');
|
|
727
|
+
// Reject strings that look like sentences (informational text)
|
|
728
|
+
// Heuristic: contains multiple spaces and ends with a period, or contains typical sentence punctuation
|
|
729
|
+
// But skip this heuristic if the string looks like a path (contains '/' or starts with a drive letter)
|
|
730
|
+
if (filename.trim().length > 60 && // long enough to be a sentence
|
|
731
|
+
/[.!?]/.test(filename) && // contains sentence punctuation
|
|
732
|
+
filename.split(' ').length > 8 && // has many words
|
|
733
|
+
!/\/|^[A-Z]:/i.test(filenameSlashes) // do NOT treat as sentence if looks like a path
|
|
734
|
+
) {
|
|
727
735
|
return false;
|
|
728
736
|
}
|
|
729
|
-
const filenameSlashes = filename.split('\\').join('/');
|
|
730
737
|
// Absolute Unix path: /hello.txt
|
|
731
738
|
if (/^(\/)/i.test(filenameSlashes)) {
|
|
732
739
|
// console.log(filename, 'Absolute Unix path: /hello.txt');
|
|
733
740
|
return true;
|
|
734
741
|
}
|
|
735
|
-
// Absolute Windows path:
|
|
736
|
-
if (/^
|
|
742
|
+
// Absolute Windows path: C:/ or C:\ (allow spaces and multiple dots in filename)
|
|
743
|
+
if (/^[A-Z]:\/.+$/i.test(filenameSlashes)) {
|
|
737
744
|
// console.log(filename, 'Absolute Windows path: /hello.txt');
|
|
738
745
|
return true;
|
|
739
746
|
}
|
|
@@ -5680,7 +5687,7 @@
|
|
|
5680
5687
|
};
|
|
5681
5688
|
/**
|
|
5682
5689
|
* TODO: Refactor this - each profile must be alongside the provider definition
|
|
5683
|
-
* TODO: Unite `AvatarProfileProps`
|
|
5690
|
+
* TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
|
|
5684
5691
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
5685
5692
|
*/
|
|
5686
5693
|
|